--- title: "Get a dashboard" method: GET path: "/api/v1/dashboard/{dashboard_id}" tags: ["Dashboards"] --- # Get a dashboard `GET /api/v1/dashboard/{dashboard_id}` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}` - Auth: one of: - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` - OAuth 2 - Authorization code: `/oauth2/v1/authorize` - Token URL: `/oauth2/v1/token` scopes: `dashboards_read` Get a dashboard using the specified ID. ## Path parameters - `dashboard_id` string, required ## Response `200` OK - Dashboard: A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure. - `author_handle` string: Identifier of the dashboard author. - `author_name` string, nullable: Name of the dashboard author. - `created_at` string, date-time: Creation date of the dashboard. - `description` string, nullable: Description of the dashboard. - `id` string: ID of the dashboard. - `is_read_only` boolean: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards. - `layout_type` 'ordered' | 'free', required: Layout type of the dashboard. - `modified_at` string, date-time: Modification date of the dashboard. - `notify_list` string[], nullable: List of handles of users to notify when changes are made to this dashboard. - `reflow_type` 'auto' | 'fixed': Reflow type for a **new dashboard layout** dashboard. Set this only when layout type is 'ordered'. If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto', widgets should not have layouts. - `restricted_roles` string[]: A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. - `tabs` DashboardTab[], nullable: List of tabs for organizing dashboard widgets into groups. - `id` string, uuid, required: UUID of the tab. - `name` string, required: Name of the tab. - `widget_ids` integer[], required: List of widget IDs belonging to this tab. The backend also accepts positional references in @N format (1-indexed) as a convenience for Terraform and other declarative tools. - `tags` string[], nullable: List of team names representing ownership of a dashboard. - `template_variable_presets` DashboardTemplateVariablePreset[], nullable: Array of template variables saved views. - `name` string: The name of the variable. - `template_variables` DashboardTemplateVariablePresetValue[]: List of variables. - `name` string: The name of the variable. - `value` string: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. - `values` string[]: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. Cannot be used in conjunction with `value`. - `template_variables` DashboardTemplateVariable[], nullable: List of template variables for this dashboard. - `available_values` string[], nullable: The list of values that the template variable drop-down is limited to. - `default` string, nullable: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. - `defaults` string[]: One or many default values for template variables on load. If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`. - `name` string, required: The name of the variable. - `prefix` string, nullable: The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. - `type` string, nullable: The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). - `title` string, required: Title of the dashboard. - `url` string: The URL of the dashboard. - `widgets` Widget[], required: List of widgets to display on the dashboard. - `definition` union, required: [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). - AlertGraphWidgetDefinition: Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. - `alert_id` string, required: ID of the alert to use in the widget. - `description` string: The description of the widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: The title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'alert_graph', required: Type of the alert graph widget. - `viz_type` 'timeseries' | 'toplist', required: Whether to display the Alert Graph as a timeseries or a top list. - AlertValueWidgetDefinition: Alert values are query values showing the current value of the metric in any monitor defined on your system. - `alert_id` string, required: ID of the alert to use in the widget. - `description` string: The description of the widget. - `precision` integer: Number of decimal to show. If not defined, will use the raw value. - `text_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of value in the widget. - `type` 'alert_value', required: Type of the alert value widget. - `unit` string: Unit to display with the value. - BarChartWidgetDefinition: The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `requests` BarChartWidgetRequest[], required: List of bar chart widget requests. - `apm_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `audit_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - `comparator` '=' | '>' | '>=' | '<' | '<=', required: Comparator to apply. - `custom_bg_color` string: Color palette to apply to the background, same values available as palette. - `custom_fg_color` string: Color palette to apply to the foreground, same values available as palette. - `hide_value` boolean: True hides values. - `image_url` string: Displays an image as the background. - `metric` string: Metric from the request to correlate this conditional format with. - `palette` 'blue' | 'custom_bg' | 'custom_image' | 'custom_text' | 'gray_on_white' | 'grey' | 'green' | 'orange' | 'red' | 'red_on_white' | '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', required: Color palette to apply. - `timeframe` string: Defines the displayed timeframe. - `value` number, double, required: Value for the comparator. - `event_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `network_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - `filter_by` string[]: List of processes. - `limit` integer: Max number of items in the filter list. - `metric` string, required: Your chosen metric. - `search_by` string: Your chosen search term. - `profile_metrics_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: Widget query. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `sort` WidgetSortBy: The controls for sorting the widget. - `count` integer: The number of items to limit the widget to. - `order_by` WidgetSortOrderBy[]: The array of items to sort the widget by in order. - … - `style` WidgetRequestStyle: Define request widget style. - `line_type` 'dashed' | 'dotted' | 'solid': Type of lines displayed. - `line_width` 'normal' | 'thick' | 'thin': Width of line displayed. - `order_by` 'tags' | 'values': How to order series in timeseries visualizations. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) - `palette` string: Color palette to apply to the widget. - `style` BarChartWidgetStyle: Style customization for a bar chart widget. - `display` union: Bar chart widget display options. - BarChartWidgetStacked: Bar chart widget stacked display options. - … - BarChartWidgetFlat: Bar chart widget flat display. - … - `palette` string: Color palette to apply to the widget. - `scaling` 'absolute' | 'relative': Bar chart widget scaling definition. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'bar_chart', required: Type of the bar chart widget. - ChangeWidgetDefinition: The Change graph shows you the change in a value over the time period chosen. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `requests` ChangeWidgetRequest[], required: Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. - `apm_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `change_type` 'absolute' | 'relative': Show the absolute or the relative change. - `compare_to` 'hour_before' | 'day_before' | 'week_before' | 'month_before': Timeframe used for the change comparison. - `event_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `increase_good` boolean: Whether to show increase as good. - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `network_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `order_by` 'change' | 'name' | 'present' | 'past': What to order by. - `order_dir` 'asc' | 'desc': Widget sorting methods. - `process_query` ProcessQueryDefinition: The process query to use in the widget. - `filter_by` string[]: List of processes. - `limit` integer: Max number of items in the filter list. - `metric` string, required: Your chosen metric. - `search_by` string: Your chosen search term. - `profile_metrics_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: Query definition. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `show_present` boolean: Whether to show the present value. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'change', required: Type of the change widget. - CheckStatusWidgetDefinition: Check status shows the current status or number of results for any check performed. - `check` string, required: Name of the check to use in the widget. - `description` string: The description of the widget. - `group` string: Group reporting a single check. - `group_by` string[]: List of tag prefixes to group by in the case of a cluster check. - `grouping` 'check' | 'cluster', required: The kind of grouping to use. - `tags` string[]: List of tags used to filter the groups reporting a cluster check. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'check_status', required: Type of the check status widget. - CohortWidgetDefinition: The cohort widget visualizes user retention over time. - `description` string: The description of the widget. - `requests` RetentionGridRequest[], required: List of Cohort widget requests. - `query` RetentionQuery, required: Retention query definition. - `compute` RetentionCompute, required: Compute configuration for retention queries. - … - `data_source` 'product_analytics_retention', required: Data source for retention queries. - `filters` RetentionFilters: Filters for retention queries. - … - `group_by` RetentionGroupBy[]: Group by configuration. - … - `name` string: Name of the query. - `search` RetentionSearch, required: Search configuration for retention queries. - … - `request_type` 'retention_grid', required: Request type for retention grid widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'cohort', required: Type of the Cohort widget. - DistributionWidgetDefinition: The Distribution visualization is another way of showing metrics aggregated across one or several tags, such as hosts. Unlike the heat map, a distribution graph’s x-axis is quantity rather than time. - `custom_links` WidgetCustomLink[]: A list of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `legend_size` string: (Deprecated) The widget legend was replaced by a tooltip and sidebar. - `markers` WidgetMarker[]: List of markers. - `display_type` string: Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. - `label` string: Label to display over the marker. - `time` string: Timestamp for the widget. - `value` string, required: Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90). - `requests` DistributionWidgetRequest[], required: Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. - `apm_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `apm_stats_query` ApmStatsQueryDefinition: The APM stats query for table and distributions widgets. - `columns` ApmStatsQueryColumnType[]: Column properties used by the front end for display. - … - `env` string, required: Environment name. - `name` string, required: Operation name associated with service. - `primary_tag` string, required: The organization's host group name and value. - `resource` string: Resource name. - `row_type` 'service' | 'resource' | 'span', required: The level of detail for the request. - `service` string, required: Service name. - `event_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `network_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - `filter_by` string[]: List of processes. - `limit` integer: Max number of items in the filter list. - `metric` string, required: Your chosen metric. - `search_by` string: Your chosen search term. - `profile_metrics_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: Widget query. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `query` union: Query definition for Distribution Widget Histogram Request - FormulaAndFunctionMetricQueryDefinition: A formula and functions metrics query. - … - FormulaAndFunctionEventQueryDefinition: A formula and functions events query. - … - FormulaAndFunctionApmResourceStatsQueryDefinition: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. - … - FormulaAndFunctionApmMetricsQueryDefinition: A formula and functions APM metrics query. - … - `request_type` 'histogram': Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:` for points distributions. - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `style` WidgetStyle: Widget style definition. - `palette` string: Color palette to apply to the widget. - `show_legend` boolean: (Deprecated) The widget legend was replaced by a tooltip and sidebar. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'distribution', required: Type of the distribution widget. - `xaxis` DistributionWidgetXAxis: X Axis controls for the distribution widget. - `include_zero` boolean: True includes zero. - `max` string: Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. - `min` string: Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. - `num_buckets` integer: Number of value buckets to target, also known as the resolution of the value bins. - `scale` string: Specifies the scale type. Possible values are `linear`. - `yaxis` DistributionWidgetYAxis: Y Axis controls for the distribution widget. - `include_zero` boolean: True includes zero. - `label` string: The label of the axis to display on the graph. - `max` string: Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. - `min` string: Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. - `scale` string: Specifies the scale type. Possible values are `linear` or `log`. - EventStreamWidgetDefinition: The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. - `description` string: The description of the widget. - `event_size` 's' | 'l': Size to use to display an event. - `query` string, required: Query to filter the event stream with. - `tags_execution` string: The execution method for multi-value filters. Can be either and or or. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'event_stream', required: Type of the event stream widget. - EventTimelineWidgetDefinition: The event timeline is a widget version of the timeline that appears at the top of the Event Stream view. Only available on FREE layout dashboards. - `description` string: The description of the widget. - `query` string, required: Query to filter the event timeline with. - `tags_execution` string: The execution method for multi-value filters. Can be either and or or. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'event_timeline', required: Type of the event timeline widget. - FreeTextWidgetDefinition: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. - `background_color` string: Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`. - `color` string: Color of the text. - `font_size` string: Size of the text. - `text` string, required: Text to display. - `text_align` 'center' | 'left' | 'right': How to align the text on the widget. - `type` 'free_text', required: Type of the free text widget. - FunnelWidgetDefinition: The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. - `description` string: The description of the widget. - `grouped_display` 'stacked' | 'side_by_side': Display mode for grouped funnel results. - `requests` FunnelWidgetRequest[], required: Request payload used to query items. - `query` FunnelQuery, required: Updated funnel widget. - `data_source` 'rum', required: Source from which to query items to display in the funnel. - `query_string` string, required: The widget query. - `steps` FunnelStep[], required: List of funnel steps. - … - `request_type` 'funnel', required: Widget request type. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: The title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: The size of the title. - `type` 'funnel', required: Type of funnel widget. - ProductAnalyticsFunnelWidgetDefinition: The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics. - `description` string: The description of the widget. - `grouped_display` 'stacked' | 'side_by_side': Display mode for grouped funnel results. - `requests` ProductAnalyticsFunnelRequest[], required: Request payload used to query items. - `comparison_segments` string[]: Comparison segments. - `comparison_time` FunnelComparisonDuration: Comparison time configuration for funnel widgets. - `custom_timeframe` FunnelComparisonCustomTimeframe: Custom timeframe for funnel comparison. - … - `type` 'previous_timeframe' | 'custom_timeframe' | 'previous_day' | 'previous_week' | 'previous_month', required: Type of comparison duration. - `query` ProductAnalyticsFunnelQuery, required: User journey funnel query definition. - `compute` ProductAnalyticsFunnelCompute: Compute configuration for user journey funnel. - … - `data_source` 'product_analytics_journey', required: Data source for user journey funnel queries. - `group_by` ProductAnalyticsFunnelGroupBy[]: Group by configuration. - … - `search` UserJourneySearch, required: User journey search configuration. - … - `subquery_id` string: Subquery ID. - `request_type` 'user_journey_funnel', required: Request type for user journey funnel widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: The title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: The size of the title. - `type` 'funnel', required: Type of funnel widget. - GeomapWidgetDefinition: This visualization displays a series of values by country on a world map. - `custom_links` WidgetCustomLink[]: A list of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `requests` GeomapWidgetRequest[], required: Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`. - `columns` ListStreamColumn[]: Widget columns. - `field` string, required: Widget column field. - `width` 'auto' | 'compact' | 'full', required: Widget column width. - `conditional_formats` WidgetConditionalFormat[]: Threshold (numeric) conditional formatting rules may be used by a regions layer. - `comparator` '=' | '>' | '>=' | '<' | '<=', required: Comparator to apply. - `custom_bg_color` string: Color palette to apply to the background, same values available as palette. - `custom_fg_color` string: Color palette to apply to the foreground, same values available as palette. - `hide_value` boolean: True hides values. - `image_url` string: Displays an image as the background. - `metric` string: Metric from the request to correlate this conditional format with. - `palette` 'blue' | 'custom_bg' | 'custom_image' | 'custom_text' | 'gray_on_white' | 'grey' | 'green' | 'orange' | 'red' | 'red_on_white' | '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', required: Color palette to apply. - `timeframe` string: Defines the displayed timeframe. - `value` number, double, required: Value for the comparator. - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `query` ListStreamQuery: Updated list stream widget. - `assignee_uuids` string[]: Filter by assignee UUIDs. Usable only with `issue_stream`. - `clustering_pattern_field_path` string: Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. - `compute` ListStreamComputeItems[]: Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source. - … - `data_source` 'logs_stream' | 'audit_stream' | 'ci_pipeline_stream' | 'ci_test_stream' | 'rum_issue_stream' | 'apm_issue_stream' | 'trace_stream' | 'logs_issue_stream' | 'logs_pattern_stream' | 'logs_transaction_stream' | 'event_stream' | 'rum_stream' | 'llm_observability_stream' | 'issue_stream', required: Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. - `event_size` 's' | 'l': Size to use to display an event. - `group_by` ListStreamGroupByItems[]: Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source. - … - `indexes` string[]: List of indexes. - `persona` 'all' | 'browser' | 'mobile' | 'backend': Persona filter for the `issue_stream` data source. - `query_string` string, required: Widget query. - `sort` WidgetFieldSort: Which column and order to sort by - … - `states` ListStreamIssueState[]: Filter by issue states. Usable only with `issue_stream`. - `storage` string: Option for storage location. Feature in Private Beta. - `suspected_causes` string[]: Filter by suspected causes. Usable only with `issue_stream`. - `team_handles` string[]: Filter by team handles. Usable only with `issue_stream`. - `version` 'sequential_query': Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `sort` WidgetSortBy: The controls for sorting the widget. - `count` integer: The number of items to limit the widget to. - `order_by` WidgetSortOrderBy[]: The array of items to sort the widget by in order. - … - `style` GeomapWidgetRequestStyle: The style to apply to the request for points layer. - `color_by` string: The category to color the points by. - `text_formats` TableWidgetTextFormatRule[]: Text formatting rules may be used by a points layer. - `custom_bg_color` string: Hex representation of the custom background color. Used with custom background palette option. - `custom_fg_color` string: Hex representation of the custom text color. Used with custom text palette option. - `match` TableWidgetTextFormatMatch, required: Match rule for the table widget text format. - … - `palette` 'white_on_red' | 'white_on_yellow' | 'white_on_green' | 'black_on_light_red' | 'black_on_light_yellow' | 'black_on_light_green' | 'red_on_white' | 'yellow_on_white' | 'green_on_white' | 'custom_bg' | 'custom_text': Color-on-color palette to highlight replaced text. - `replace` union: Replace rule for the table widget text format. - … - `style` GeomapWidgetDefinitionStyle, required: The style to apply to the widget. - `palette` string, required: The color palette to apply to the widget. - `palette_flip` boolean, required: Whether to flip the palette tones. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: The title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: The size of the title. - `type` 'geomap', required: Type of the geomap widget. - `view` GeomapWidgetDefinitionView, required: The view of the world that the map should render. - `focus` string, required: The 2-letter ISO code of a country to focus the map on, or `WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent (`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`). - GroupWidgetDefinition: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible. - `background_color` string: Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`. - `banner_img` string: URL of image to display as a banner for the group. - `layout_type` 'ordered', required: Layout type of the group. - `show_title` boolean: Whether to show the title or not. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `type` 'group', required: Type of the group widget. - `widgets` Widget[], required: List of widget groups. - HeatMapWidgetDefinition: The heat map visualization shows metrics aggregated across many tags, such as hosts. The more hosts that have a particular value, the darker that square is. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `events` WidgetEvent[]: List of widget events. Deprecated - Use `overlay` request type instead. - `q` string, required: Query definition. - `tags_execution` string: The execution method for multi-value filters. - `legend_size` string: Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". - `markers` WidgetMarker[]: List of markers. - `display_type` string: Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. - `label` string: Label to display over the marker. - `time` string: Timestamp for the widget. - `value` string, required: Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90). - `requests` HeatMapWidgetRequest[], required: List of widget types. - `apm_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `event_query` EventQueryDefinition: The event query. - `search` string, required: The query being made on the event. - `tags_execution` string, required: The execution method for multi-value filters. Can be either and or or. - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `network_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - `filter_by` string[]: List of processes. - `limit` integer: Max number of items in the filter list. - `metric` string, required: Your chosen metric. - `search_by` string: Your chosen search term. - `profile_metrics_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: Widget query. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `query` FormulaAndFunctionMetricQueryDefinition: A formula and functions metrics query. - `aggregator` 'avg' | 'min' | 'max' | 'sum' | 'last' | 'area' | 'l2norm' | 'percentile': The aggregation methods available for metrics queries. - `cross_org_uuids` string[]: The source organization UUID for cross organization queries. Feature in Private Beta. - `data_source` 'metrics', required: Data source for metrics queries. - `name` string, required: Name of the query for use in formulas. - `query` string, required: Metrics query definition. - `semantic_mode` 'combined' | 'native': Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. - `request_type` 'histogram': Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:` for points distributions. - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `style` WidgetStyle: Widget style definition. - `palette` string: Color palette to apply to the widget. - `show_legend` boolean: Whether or not to display the legend on this widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'heatmap', required: Type of the heat map widget. - `xaxis` HeatMapWidgetXAxis: X Axis controls for the heat map widget. - `num_buckets` integer: Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier). - `yaxis` WidgetAxis: Axis controls for the widget. - `include_zero` boolean: Set to `true` to include zero. - `label` string: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. - `max` string: Specifies maximum numeric value to show on the axis. Defaults to `auto`. - `min` string: Specifies minimum numeric value to show on the axis. Defaults to `auto`. - `scale` string: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). - HostMapWidgetDefinition: The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `group` string[]: Deprecated - Only used by the legacy metric-based format. Use `group_by` (infrastructure) or a `group` dimension (DDSQL) inside `requests` instead. - `no_group_hosts` boolean: Deprecated - Only used by the legacy metric-based format. Use `no_group_hosts` inside `requests` instead. - `no_metric_hosts` boolean: Deprecated - Only used by the legacy metric-based format. Use `no_metric_hosts` inside `requests` instead. - `node_type` 'host' | 'container': Which type of node to use in the map. - `notes` string: Notes on the title. - `requests` HostMapWidgetDefinitionRequests, required: Query definition for the host map widget. Supports three mutually exclusive formats distinguished by `request_type`: the deprecated legacy metric-based format (`fill`/`size`, no `request_type`), the infrastructure-backed format (`request_type: infrastructure_hostmap`), and the DDSQL published-dataset format (`request_type: data_projection`). - `child` HostMapWidgetInfrastructureRequest: Infrastructure-backed request for the host map widget. Supports entity-based visualization with metric query enrichments, tag-based filtering, flexible grouping, and hierarchical views. - `child` HostMapWidgetInfrastructureRequestLeaf: Infrastructure-backed host map child request (leaf node, no further nesting supported). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formatting rules applied to fill values. - … - `enrichments` HostMapWidgetScalarRequest[], required: Metric or event queries joined to the entity set. Each formula specifies a visual dimension. - … - `filter` string: Filter string for the entity set in tag format (for example, `env:prod`). - `group_by` HostMapWidgetGroupBy[]: Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. - … - `no_group_hosts` boolean: Whether to hide entities that have no group assignment. - `no_metric_hosts` boolean: Whether to hide entities that have no enrichment data. - `node_type` 'host' | 'container' | 'pod' | 'cluster', required: Which type of infrastructure entity to visualize in the host map. - `request_type` 'infrastructure_hostmap', required: Identifies this as an infrastructure-backed host map request. - `style` HostMapWidgetInfrastructureStyle: Style configuration for the infrastructure host map. - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formatting rules applied to fill values. - `comparator` '=' | '>' | '>=' | '<' | '<=', required: Comparator to apply. - `custom_bg_color` string: Color palette to apply to the background, same values available as palette. - `custom_fg_color` string: Color palette to apply to the foreground, same values available as palette. - `hide_value` boolean: True hides values. - `image_url` string: Displays an image as the background. - `metric` string: Metric from the request to correlate this conditional format with. - `palette` 'blue' | 'custom_bg' | 'custom_image' | 'custom_text' | 'gray_on_white' | 'grey' | 'green' | 'orange' | 'red' | 'red_on_white' | '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', required: Color palette to apply. - `timeframe` string: Defines the displayed timeframe. - `value` number, double, required: Value for the comparator. - `enrichments` HostMapWidgetScalarRequest[]: Metric or event queries joined to the entity set. Each formula specifies a visual dimension. Only used by the infrastructure-backed format. - `formulas` HostMapWidgetFormula[], required: List of formulas that operate on queries, each assigned to a visual dimension. - … - `queries` FormulaAndFunctionQueryDefinition[], required: List of queries that can be returned directly or used in formulas. - … - `response_format` 'scalar', required: Response format for the scalar formula request. Only `scalar` is supported. - `fill` HostMapRequest: Deprecated - Legacy metric-based host map request. Use the infrastructure-backed (`request_type: infrastructure_hostmap`) or DDSQL (`request_type: data_projection`) format instead. - `apm_query` LogQueryDefinition: The log query. - … - `event_query` LogQueryDefinition: The log query. - … - `log_query` LogQueryDefinition: The log query. - … - `network_query` LogQueryDefinition: The log query. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - … - `profile_metrics_query` LogQueryDefinition: The log query. - … - `q` string: Query definition. - `rum_query` LogQueryDefinition: The log query. - … - `security_query` LogQueryDefinition: The log query. - … - `filter` string: Filter string for the entity set in tag format (for example, `env:prod`). Only used by the infrastructure-backed format. - `group_by` HostMapWidgetGroupBy[]: Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. Only used by the infrastructure-backed format. - `column` string, required: Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`). - `key` string: Key within the column for nested attribute types (for example, `service` within `tags`). - `limit` integer: Maximum number of rows to return from the dataset query. Only used by the DDSQL format. - `no_group_hosts` boolean: Whether to hide entities that have no group assignment. - `no_metric_hosts` boolean: Whether to hide entities that have no enrichment data. - `node_type` 'host' | 'container' | 'pod' | 'cluster': Which type of infrastructure entity to visualize in the host map. - `projection` HostMapWidgetProjection: Projection for the DDSQL host map request. Maps dataset columns to map dimensions: `node` identifies the entity, repeated `group` entries define the grouping hierarchy (outermost first), and `fill`/`size` drive the tile color and size. - `dimensions` HostMapWidgetProjectionDimensionMapping[], required: List of column-to-dimension mappings for the projection. - … - `type` 'hostmap', required: Type of the host map projection. - `query` DatasetListQuery: Query that lists the rows of a published dataset (a DDSQL query) without aggregation. - `data_source` 'dataset', required: Identifies this as a published-dataset list query. - `dataset_id` string, required: ID of the published dataset to query. - `dataset_provider` 'ddsql_query', required: Product page that published the dataset queried by a `DatasetListQuery`. `ddsql_query` is the only provider currently supported for host map widgets. - `filter` string: Filter applied to the dataset's rows, using events-style search syntax. - `limit` integer: Maximum number of rows to return from the dataset query. - `sort` DatasetListQuerySort: Sort configuration for a `DatasetListQuery`. - … - `request_type` 'infrastructure_hostmap' | 'data_projection': Identifies which host map request format the sibling fields on `HostMapWidgetDefinitionRequests` describe: an infrastructure-backed request or a DDSQL published-dataset request. - `size` HostMapRequest: Deprecated - Legacy metric-based host map request. Use the infrastructure-backed (`request_type: infrastructure_hostmap`) or DDSQL (`request_type: data_projection`) format instead. - `apm_query` LogQueryDefinition: The log query. - … - `event_query` LogQueryDefinition: The log query. - … - `log_query` LogQueryDefinition: The log query. - … - `network_query` LogQueryDefinition: The log query. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - … - `profile_metrics_query` LogQueryDefinition: The log query. - … - `q` string: Query definition. - `rum_query` LogQueryDefinition: The log query. - … - `security_query` LogQueryDefinition: The log query. - … - `style` HostMapWidgetInfrastructureStyle: Style configuration for the infrastructure host map. - `fill_max` number, double: Maximum value for the fill color scale. Omit to use automatic scaling. - `fill_min` number, double: Minimum value for the fill color scale. Omit to use automatic scaling. - `palette` string: Color palette name or alias. - `palette_flip` boolean: Whether to invert the color palette. - `scope` string[]: Deprecated - Only used by the legacy metric-based format. Use `filter` inside `requests` instead. - `style` HostMapWidgetDefinitionStyle: Deprecated - The style to apply to the legacy metric-based host map widget. Use `HostMapWidgetInfrastructureStyle` instead. - `fill_max` string: Max value to use to color the map. - `fill_min` string: Min value to use to color the map. - `palette` string: Color palette to apply to the widget. - `palette_flip` boolean: Whether to flip the palette tones. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'hostmap', required: Type of the host map widget. - IFrameWidgetDefinition: The iframe widget allows you to embed a portion of any other web page on your dashboard. - `type` 'iframe', required: Type of the iframe widget. - `url` string, required: URL of the iframe. - ImageWidgetDefinition: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. - `has_background` boolean: Whether to display a background or not. - `has_border` boolean: Whether to display a border or not. - `horizontal_align` 'center' | 'left' | 'right': Horizontal alignment. - `margin` 'sm' | 'md' | 'lg' | 'small' | 'large': Size of the margins around the image. **Note**: `small` and `large` values are deprecated. - `sizing` 'fill' | 'contain' | 'cover' | 'none' | 'scale-down' | 'zoom' | 'fit' | 'center': How to size the image on the widget. The values are based on the image `object-fit` CSS properties. **Note**: `zoom`, `fit` and `center` values are deprecated. - `type` 'image', required: Type of the image widget. - `url` string, required: URL of the image. - `url_dark_theme` string: URL of the image in dark mode. - `vertical_align` 'center' | 'top' | 'bottom': Vertical alignment. - ListStreamWidgetDefinition: The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. - `description` string: The description of the widget. - `legend_size` string: Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". - `requests` ListStreamWidgetRequest[], required: Request payload used to query items. - `columns` ListStreamColumn[], required: Widget columns. - `field` string, required: Widget column field. - `width` 'auto' | 'compact' | 'full', required: Widget column width. - `query` ListStreamQuery, required: Updated list stream widget. - `assignee_uuids` string[]: Filter by assignee UUIDs. Usable only with `issue_stream`. - `clustering_pattern_field_path` string: Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. - `compute` ListStreamComputeItems[]: Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source. - … - `data_source` 'logs_stream' | 'audit_stream' | 'ci_pipeline_stream' | 'ci_test_stream' | 'rum_issue_stream' | 'apm_issue_stream' | 'trace_stream' | 'logs_issue_stream' | 'logs_pattern_stream' | 'logs_transaction_stream' | 'event_stream' | 'rum_stream' | 'llm_observability_stream' | 'issue_stream', required: Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. - `event_size` 's' | 'l': Size to use to display an event. - `group_by` ListStreamGroupByItems[]: Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source. - … - `indexes` string[]: List of indexes. - `persona` 'all' | 'browser' | 'mobile' | 'backend': Persona filter for the `issue_stream` data source. - `query_string` string, required: Widget query. - `sort` WidgetFieldSort: Which column and order to sort by - … - `states` ListStreamIssueState[]: Filter by issue states. Usable only with `issue_stream`. - `storage` string: Option for storage location. Feature in Private Beta. - `suspected_causes` string[]: Filter by suspected causes. Usable only with `issue_stream`. - `team_handles` string[]: Filter by team handles. Usable only with `issue_stream`. - `version` 'sequential_query': Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** - `response_format` 'event_list', required: Widget response format. - `show_legend` boolean: Whether or not to display the legend on this widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'list_stream', required: Type of the list stream widget. - LogStreamWidgetDefinition: The Log Stream displays a log flow matching the defined query. - `columns` string[]: Which columns to display on the widget. - `description` string: The description of the widget. - `indexes` string[]: An array of index names to query in the stream. Use [] to query all indexes at once. - `logset` string: ID of the log set to use. - `message_display` 'inline' | 'expanded-md' | 'expanded-lg': Amount of log lines to display - `query` string: Query to filter the log stream with. - `show_date_column` boolean: Whether to show the date column or not - `show_message_column` boolean: Whether to show the message column or not - `sort` WidgetFieldSort: Which column and order to sort by - `column` string, required: Facet path for the column - `order` 'asc' | 'desc', required: Widget sorting methods. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'log_stream', required: Type of the log stream widget. - MonitorSummaryWidgetDefinition: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. - `color_preference` 'background' | 'text': Which color to use on the widget. - `count` integer: The number of monitors to display. - `description` string: The description of the widget. - `display_format` 'counts' | 'countsAndList' | 'list': What to display on the widget. - `hide_zero_counts` boolean: Whether to show counts of 0 or not. - `query` string, required: Query to filter the monitors with. - `show_last_triggered` boolean: Whether to show the time that has elapsed since the monitor/group triggered. - `show_priority` boolean: Whether to show the priorities column. - `sort` 'name' | 'group' | 'status' | 'tags' | 'triggered' | 'group,asc' | 'group,desc' | 'name,asc' | 'name,desc' | 'status,asc' | 'status,desc' | 'tags,asc' | 'tags,desc' | 'triggered,asc' | 'triggered,desc' | 'priority,asc' | 'priority,desc': Widget sorting methods. - `start` integer: The start of the list. Typically 0. - `summary_type` 'monitors' | 'groups' | 'combined': Which summary type should be used. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'manage_status', required: Type of the monitor summary widget. - NoteWidgetDefinition: The notes and links widget is similar to free text widget, but allows for more formatting options. - `background_color` string: Background color of the note. - `content` string, required: Content of the note. - `font_size` string: Size of the text. - `has_padding` boolean: Whether to add padding or not. - `show_tick` boolean: Whether to show a tick or not. - `text_align` 'center' | 'left' | 'right': How to align the text on the widget. - `tick_edge` 'bottom' | 'left' | 'right' | 'top': Define how you want to align the text on the widget. - `tick_pos` string: Where to position the tick on an edge. - `type` 'note', required: Type of the note widget. - `vertical_align` 'center' | 'top' | 'bottom': Vertical alignment. - PowerpackWidgetDefinition: The powerpack widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible. - `background_color` string: Background color of the powerpack title. - `banner_img` string: URL of image to display as a banner for the powerpack. - `powerpack_id` string, required: UUID of the associated powerpack. - `show_title` boolean: Whether to show the title or not. - `template_variables` PowerpackTemplateVariables: Powerpack template variables. - `controlled_by_powerpack` PowerpackTemplateVariableContents[]: Template variables controlled at the powerpack level. - `name` string, required: The name of the variable. - `prefix` string: The tag prefix associated with the variable. - `values` string[], required: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. - `controlled_externally` PowerpackTemplateVariableContents[]: Template variables controlled by the external resource, such as the dashboard this powerpack is on. - `name` string, required: The name of the variable. - `prefix` string: The tag prefix associated with the variable. - `values` string[], required: One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. - `title` string: Title of the widget. - `type` 'powerpack', required: Type of the powerpack widget. - PointPlotWidgetDefinition: The point plot displays individual data points over time. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `legend` PointPlotWidgetLegend: Legend configuration for the point plot widget. - `type` 'automatic' | 'none', required: Type of legend to show for the point plot widget. - `markers` WidgetMarker[]: List of markers for the widget. - `display_type` string: Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. - `label` string: Label to display over the marker. - `time` string: Timestamp for the widget. - `value` string, required: Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90). - `requests` PointPlotWidgetRequest[], required: List of request configurations for the widget. - `limit` integer: Maximum number of data points to return. - `projection` PointPlotProjection, required: Projection configuration for the point plot widget. - `dimensions` PointPlotProjectionDimension[], required: List of dimension mappings for the projection. - … - `extra_columns` string[]: Additional columns to include in the projection. - `type` 'point_plot', required: Type of the projection. - `query` DataProjectionQuery, required: Query configuration for a data projection request. - `data_source` string, required: Data source for the query. - `indexes` string[]: List of indexes to query. - `query_string` string, required: The query string to filter events. - `storage` string: Storage location for the query. - `request_type` 'data_projection', required: Type of a data projection request. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'point_plot', required: Type of the point plot widget. - `yaxis` WidgetAxis: Axis controls for the widget. - `include_zero` boolean: Set to `true` to include zero. - `label` string: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. - `max` string: Specifies maximum numeric value to show on the axis. Defaults to `auto`. - `min` string: Specifies minimum numeric value to show on the axis. Defaults to `auto`. - `scale` string: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). - QueryValueWidgetDefinition: Query values display the current value of a given metric, APM, or log query. - `autoscale` boolean: Whether to use auto-scaling or not. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `custom_unit` string: Display a unit of your choice on the widget. - `description` string: The description of the widget. - `precision` integer: Number of decimals to show. If not defined, the widget uses the raw value. - `requests` QueryValueWidgetRequest[], required: Widget definition. - `aggregator` 'avg' | 'last' | 'max' | 'min' | 'sum' | 'percentile': Aggregator used for the request. - `apm_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `audit_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `comparison` QueryValueWidgetComparison: A change indicator that compares the current value to a historical period. - `directionality` 'increase_better' | 'decrease_better' | 'neutral': Color-coding direction: `increase_better` (green on rise), `decrease_better` (green on drop), or `neutral` (no color). - `duration` ComparisonDuration, required: The comparison period. Use a preset `type` value or set `type` to `custom_timeframe` and provide `custom_timeframe` with explicit millisecond epoch bounds. - … - `type` 'absolute' | 'relative' | 'both': How the delta is expressed: `absolute` (raw difference), `relative` (percentage), or `both`. - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - `comparator` '=' | '>' | '>=' | '<' | '<=', required: Comparator to apply. - `custom_bg_color` string: Color palette to apply to the background, same values available as palette. - `custom_fg_color` string: Color palette to apply to the foreground, same values available as palette. - `hide_value` boolean: True hides values. - `image_url` string: Displays an image as the background. - `metric` string: Metric from the request to correlate this conditional format with. - `palette` 'blue' | 'custom_bg' | 'custom_image' | 'custom_text' | 'gray_on_white' | 'grey' | 'green' | 'orange' | 'red' | 'red_on_white' | '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', required: Color palette to apply. - `timeframe` string: Defines the displayed timeframe. - `value` number, double, required: Value for the comparator. - `event_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `formulas` WidgetFormula[]: List of formulas that operate on queries. - `alias` string: Expression alias. - `cell_display_mode` 'number' | 'bar' | 'trend': Define a display mode for the table cell. - `cell_display_mode_options` WidgetFormulaCellDisplayModeOptions: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). - … - `conditional_formats` WidgetConditionalFormat[]: List of conditional formats. - … - `formula` string, required: String expression built from queries, formulas, and functions. - `limit` WidgetFormulaLimit: Options for limiting results returned. - … - `number_format` WidgetNumberFormat: Number format options for the widget. - … - `style` WidgetFormulaStyle: Styling options for widget formulas. - … - `log_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `network_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - `filter_by` string[]: List of processes. - `limit` integer: Max number of items in the filter list. - `metric` string, required: Your chosen metric. - `search_by` string: Your chosen search term. - `profile_metrics_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `q` string: Widget query. Deprecated - Use `queries` and `formulas` instead. - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - union: A formula and function query. - … - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `rum_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `security_query` LogQueryDefinition: The log query. - `compute` LogsQueryCompute: Define computation for a log query. - … - `group_by` LogQueryDefinitionGroupBy[]: List of tag prefixes to group by in the case of a cluster check. - … - `index` string: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) - `multi_compute` LogsQueryCompute[]: This field is mutually exclusive with `compute`. - … - `search` LogQueryDefinitionSearch: The query being made on the logs. - … - `text_align` 'center' | 'left' | 'right': How to align the text on the widget. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `timeseries_background` TimeseriesBackground: Set a timeseries on the widget background. - `type` 'bars' | 'area', required: Timeseries is made using an area or bars. - `yaxis` WidgetAxis: Axis controls for the widget. - `include_zero` boolean: Set to `true` to include zero. - `label` string: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. - `max` string: Specifies maximum numeric value to show on the axis. Defaults to `auto`. - `min` string: Specifies minimum numeric value to show on the axis. Defaults to `auto`. - `scale` string: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'query_value', required: Type of the query value widget. - RetentionCurveWidgetDefinition: The retention curve widget visualizes user retention rates over time. - `description` string: The description of the widget. - `requests` RetentionCurveWidgetRequest[], required: List of Retention Curve widget requests. - `query` RetentionQuery, required: Retention query definition. - `compute` RetentionCompute, required: Compute configuration for retention queries. - … - `data_source` 'product_analytics_retention', required: Data source for retention queries. - `filters` RetentionFilters: Filters for retention queries. - … - `group_by` RetentionGroupBy[]: Group by configuration. - … - `name` string: Name of the query. - `search` RetentionSearch, required: Search configuration for retention queries. - … - `request_type` 'retention_curve', required: Request type for retention curve widget. - `style` RetentionCurveStyle: Style configuration for retention curve. - `palette` string: Color palette for the retention curve. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'retention_curve', required: Type of the Retention Curve widget. - RunWorkflowWidgetDefinition: Run workflow is widget that allows you to run a workflow from a dashboard. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `inputs` RunWorkflowWidgetInput[]: Array of workflow inputs to map to dashboard template variables. - `name` string, required: Name of the workflow input. - `value` string, required: Dashboard template variable. Can be suffixed with '.value' or '.key'. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'run_workflow', required: Type of the run workflow widget. - `workflow_id` string, required: Workflow id. - SLOListWidgetDefinition: Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. - `description` string: The description of the widget. - `requests` SLOListWidgetRequest[], required: Array of one request object to display in the widget. - `query` SLOListWidgetQuery, required: Updated SLO List widget. - `limit` integer: Maximum number of results to display in the table. - `query_string` string, required: Widget query. - `sort` WidgetFieldSort[]: Options for sorting results. - … - `request_type` 'slo_list', required: Widget request type. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'slo_list', required: Type of the SLO List widget. - SLOWidgetDefinition: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. - `additional_query_filters` string: Additional filters applied to the SLO query. - `description` string: The description of the widget. - `global_time_target` string: Defined global time target. - `show_error_budget` boolean: Defined error budget. - `slo_id` string: ID of the SLO displayed. - `time_windows` WidgetTimeWindows[]: Times being monitored. - `title` string: Title of the widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'slo', required: Type of the SLO widget. - `view_mode` 'overall' | 'component' | 'both': Define how you want the SLO to be displayed. - `view_type` string, required: Type of view displayed by the widget. - ScatterPlotWidgetDefinition: The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. - `color_by_groups` string[]: List of groups used for colors. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `requests` ScatterPlotWidgetDefinitionRequests, required: Widget definition. - `table` ScatterplotTableRequest: Scatterplot request containing formulas and functions. - `formulas` ScatterplotWidgetFormula[]: List of Scatterplot formulas that operate on queries. - … - `queries` FormulaAndFunctionQueryDefinition[]: List of queries that can be returned directly or used in formulas. - … - `response_format` 'timeseries' | 'scalar' | 'event_list': Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. - `x` ScatterPlotRequest: Updated scatter plot. - `aggregator` 'avg' | 'last' | 'max' | 'min' | 'sum': Aggregator used for the request. - `apm_query` LogQueryDefinition: The log query. - … - `event_query` LogQueryDefinition: The log query. - … - `log_query` LogQueryDefinition: The log query. - … - `network_query` LogQueryDefinition: The log query. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - … - `profile_metrics_query` LogQueryDefinition: The log query. - … - `q` string: Query definition. - `rum_query` LogQueryDefinition: The log query. - … - `security_query` LogQueryDefinition: The log query. - … - `y` ScatterPlotRequest: Updated scatter plot. - `aggregator` 'avg' | 'last' | 'max' | 'min' | 'sum': Aggregator used for the request. - `apm_query` LogQueryDefinition: The log query. - … - `event_query` LogQueryDefinition: The log query. - … - `log_query` LogQueryDefinition: The log query. - … - `network_query` LogQueryDefinition: The log query. - … - `process_query` ProcessQueryDefinition: The process query to use in the widget. - … - `profile_metrics_query` LogQueryDefinition: The log query. - … - `q` string: Query definition. - `rum_query` LogQueryDefinition: The log query. - … - `security_query` LogQueryDefinition: The log query. - … - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'scatterplot', required: Type of the scatter plot widget. - `xaxis` WidgetAxis: Axis controls for the widget. - `include_zero` boolean: Set to `true` to include zero. - `label` string: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. - `max` string: Specifies maximum numeric value to show on the axis. Defaults to `auto`. - `min` string: Specifies minimum numeric value to show on the axis. Defaults to `auto`. - `scale` string: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). - `yaxis` WidgetAxis: Axis controls for the widget. - `include_zero` boolean: Set to `true` to include zero. - `label` string: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. - `max` string: Specifies maximum numeric value to show on the axis. Defaults to `auto`. - `min` string: Specifies minimum numeric value to show on the axis. Defaults to `auto`. - `scale` string: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). - SankeyWidgetDefinition: The Sankey diagram visualizes the flow of data between categories, stages or sets of values. - `requests` SankeyWidgetRequest[], required: List of Sankey widget requests. - union: Request definition for Sankey widget. - SankeyRumRequest: Sankey widget request for Product Analytics or RUM data source. - … - SankeyNetworkRequest: Sankey widget request for network data source. - … - `show_other_links` boolean: Whether to show links for "other" category. - `sort_nodes` boolean: Whether to sort nodes in the Sankey diagram. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - `unit` 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year', required: Unit of the time span. - `value` integer, required: Value of the time span. - WidgetNewFixedSpan: Used for fixed span times, such as 'March 1 to March 7'. - `from` integer, required: Start time in milliseconds since epoch. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `to` integer, required: End time in milliseconds since epoch. - `type` 'fixed', required: Type "fixed" denotes a fixed span. - `title` string: Title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'sankey', required: Type of the Sankey widget. - ServiceMapWidgetDefinition: This widget displays a map of a service to all of the services that call it, and all of the services that it calls. - `custom_links` WidgetCustomLink[]: List of custom links. - `is_hidden` boolean: The flag for toggling context menu link visibility. - `label` string: The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. - `link` string: The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. - `override_label` string: The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. - `description` string: The description of the widget. - `filters` string[], required: Your environment and primary tag (or * if enabled for your account). - `service` string, required: The ID of the service you want to map. - `title` string: The title of your widget. - `title_align` 'center' | 'left' | 'right': How to align the text on the widget. - `title_size` string: Size of the title. - `type` 'servicemap', required: Type of the service map widget. - ServiceSummaryWidgetDefinition: The service summary displays the graphs of a chosen service in your dashboard. - `description` string: The description of the widget. - `display_format` 'one_column' | 'two_column' | 'three_column': Number of columns to display. - `env` string, required: APM environment. - `service` string, required: APM service. - `show_breakdown` boolean: Whether to show the latency breakdown or not. - `show_distribution` boolean: Whether to show the latency distribution or not. - `show_errors` boolean: Whether to show the error metrics or not. - `show_hits` boolean: Whether to show the hits metrics or not. - `show_latency` boolean: Whether to show the latency metrics or not. - `show_resource_list` boolean: Whether to show the resource list or not. - `size_format` 'small' | 'medium' | 'large': Size of the widget. - `span_name` string, required: APM span name. - `time` union: Time setting for the widget. - WidgetLegacyLiveSpan: Wrapper for live span - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `live_span` '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '4h' | '1d' | '2d' | '1w' | '1mo' | '3mo' | '6mo' | 'week_to_date' | 'month_to_date' | '1y' | 'alert': The available timeframes depend on the widget you are using. - WidgetNewLiveSpan: Used for arbitrary live span times, such as 17 minutes or 6 hours. - `hide_incomplete_cost_data` boolean: Whether to hide incomplete cost data in the widget. - `type` 'live', required: Type "live" denotes a live span in the new format. - … truncated; see the full OpenAPI document linked below ## Other responses - `403`: Authentication Error - `404`: Item Not Found - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v1-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v1-collection/revisions/ca5871004d26?raw)