--- title: Dashboards description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Dashboards --- # Dashboards Manage all your dashboards, as well as access to your shared dashboards, through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/) for more information. ## Create a new dashboard{% #create-a-new-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/dashboard | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/dashboard | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/dashboard | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/dashboard | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/dashboard | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/dashboard | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/dashboard | ### Overview Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended. Refer to the following [documentation](https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#in-application-modifiers) for more information on these modifiers. This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Request #### Body Data (required) Create a dashboard request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------------- | ------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | author_handle | string | Identifier of the dashboard author. | | | author_name | string | Name of the dashboard author. | | | created_at | date-time | Creation date of the dashboard. | | | description | string | Description of the dashboard. | | | id | string | ID of the dashboard. | | | is_read_only | boolean | **DEPRECATED**: 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 [*required*] | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | | modified_at | date-time | Modification date of the dashboard. | | | notify_list | [string] | List of handles of users to notify when changes are made to this dashboard. | | | reflow_type | enum | 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. Allowed enum values: `auto,fixed` | | | 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 | [object] | List of tabs for organizing dashboard widgets into groups. | | tabs | id [*required*] | uuid | UUID of the tab. | | tabs | name [*required*] | string | Name of the tab. | | tabs | widget_ids [*required*] | [integer] | 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] | List of team names representing ownership of a dashboard. | | | template_variable_presets | [object] | Array of template variables saved views. | | template_variable_presets | name | string | The name of the variable. | | template_variable_presets | template_variables | [object] | List of variables. | | template_variables | name | string | The name of the variable. | | template_variables | value | string | **DEPRECATED**: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. | | template_variables | 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 | [object] | List of template variables for this dashboard. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. | | template_variables | 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`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | template_variables | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | | title [*required*] | string | Title of the dashboard. | | | url | string | The URL of the dashboard. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). | | definition | Option 1 | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | Option 1 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 1 | description | string | The description of the widget. | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | The title of the widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph` | | Option 1 | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist` | | definition | Option 2 | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | Option 2 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 2 | description | string | The description of the widget. | | Option 2 | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | Option 2 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of value in the widget. | | Option 2 | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value` | | Option 2 | unit | string | Unit to display with the value. | | definition | Option 3 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 3 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 3 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | Title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | Size of the title. | | Option 3 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | definition | Option 4 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | description | string | The description of the widget. | | Option 4 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | title | string | Title of the widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | definition | Option 5 | object | Check status shows the current status or number of results for any check performed. | | Option 5 | check [*required*] | string | Name of the check to use in the widget. | | Option 5 | description | string | The description of the widget. | | Option 5 | group | string | Group reporting a single check. | | Option 5 | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | Option 5 | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check,cluster` | | Option 5 | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of the widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status` | | definition | Option 6 | object | 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. | | Option 6 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 6 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | requests | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | requests | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of the widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution` | | Option 6 | xaxis | object | X Axis controls for the distribution widget. | | xaxis | include_zero | boolean | True includes zero. | | xaxis | max | string | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | min | string | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | num_buckets | int64 | Number of value buckets to target, also known as the resolution of the value bins. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`. | | Option 6 | yaxis | object | Y Axis controls for the distribution widget. | | yaxis | include_zero | boolean | True includes zero. | | yaxis | label | string | The label of the axis to display on the graph. | | yaxis | max | string | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. | | definition | Option 7 | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | Option 7 | description | string | The description of the widget. | | Option 7 | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | Option 7 | query [*required*] | string | Query to filter the event stream with. | | Option 7 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of the widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream` | | definition | Option 8 | object | 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. | | Option 8 | description | string | The description of the widget. | | Option 8 | query [*required*] | string | Query to filter the event timeline with. | | Option 8 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of the widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline` | | definition | Option 9 | object | Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. | | Option 9 | 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`. | | Option 9 | color | string | Color of the text. | | Option 9 | font_size | string | Size of the text. | | Option 9 | text [*required*] | string | Text to display. | | Option 9 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text` | | definition | Option 10 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Option 10 | description | string | The description of the widget. | | Option 10 | requests [*required*] | [object] | Request payload used to query items. | | requests | query [*required*] | object | Updated funnel widget. | | query | data_source [*required*] | enum | Source from which to query items to display in the funnel. Allowed enum values: `rum` | | query | query_string [*required*] | string | The widget query. | | query | steps [*required*] | [object] | List of funnel steps. | | steps | facet [*required*] | string | The facet of the step. | | steps | value [*required*] | string | The value of the step. | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `funnel` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | The title of the widget. | | Option 10 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 10 | title_size | string | The size of the title. | | Option 10 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel` | | definition | Option 11 | object | This visualization displays a series of values by country on a world map. | | Option 11 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 11 | description | string | The description of the widget. | | Option 11 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 11 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 11 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 11 | title | string | The title of your widget. | | Option 11 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 11 | title_size | string | The size of the title. | | Option 11 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 11 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | definition | Option 12 | object | 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. | | Option 12 | 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`. | | Option 12 | banner_img | string | URL of image to display as a banner for the group. | | Option 12 | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered` | | Option 12 | show_title | boolean | Whether to show the title or not. | | Option 12 | title | string | Title of the widget. | | Option 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 12 | type [*required*] | enum | Type of the group widget. Allowed enum values: `group` | | Option 12 | widgets [*required*] | [object] | List of widget groups. | | definition | Option 13 | object | 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. | | Option 13 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 13 | description | string | The description of the widget. | | Option 13 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 13 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 13 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 13 | requests [*required*] | [object] | List of widget types. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | search [*required*] | string | The query being made on the event. | | event_query | tags_execution [*required*] | string | The execution method for multi-value filters. Can be either and or or. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | A formula and functions metrics query. | | query | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | query | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | query | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | query | name [*required*] | string | Name of the query for use in formulas. | | query | query [*required*] | string | Metrics query definition. | | query | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | requests | request_type | enum | Applicable only for distribution of point values for distribution metrics. Allowed enum values: `histogram` | | requests | response_format | enum | Applicable only for distribution of aggregated grouped queries. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 13 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 13 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 13 | title | string | Title of the widget. | | Option 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 13 | title_size | string | Size of the title. | | Option 13 | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap` | | Option 13 | xaxis | object | X Axis controls for the heat map widget. | | xaxis | num_buckets | int64 | 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). | | Option 13 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 14 | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | Option 14 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 14 | description | string | The description of the widget. | | Option 14 | group | [string] | List of tag prefixes to group by. | | Option 14 | no_group_hosts | boolean | Whether to show the hosts that don't fit in a group. | | Option 14 | no_metric_hosts | boolean | Whether to show the hosts with no metrics. | | Option 14 | node_type | enum | Which type of node to use in the map. Allowed enum values: `host,container` | | Option 14 | notes | string | Notes on the title. | | Option 14 | requests [*required*] | object | List of definitions. | | requests | fill | object | Updated host map. | | fill | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | fill | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | q | string | Query definition. | | fill | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | size | object | Updated host map. | | size | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | size | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | q | string | Query definition. | | size | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 14 | scope | [string] | List of tags used to filter the map. | | Option 14 | style | object | The style to apply to the widget. | | style | fill_max | string | Max value to use to color the map. | | style | fill_min | string | Min value to use to color the map. | | style | palette | string | Color palette to apply to the widget. | | style | palette_flip | boolean | Whether to flip the palette tones. | | Option 14 | title | string | Title of the widget. | | Option 14 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 14 | title_size | string | Size of the title. | | Option 14 | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap` | | definition | Option 15 | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | Option 15 | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe` | | Option 15 | url [*required*] | string | URL of the iframe. | | definition | Option 16 | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | Option 16 | has_background | boolean | Whether to display a background or not. | | Option 16 | has_border | boolean | Whether to display a border or not. | | Option 16 | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center,left,right` | | Option 16 | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large` | | Option 16 | sizing | enum | 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. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center` | | Option 16 | type [*required*] | enum | Type of the image widget. Allowed enum values: `image` | | Option 16 | url [*required*] | string | URL of the image. | | Option 16 | url_dark_theme | string | URL of the image in dark mode. | | Option 16 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 17 | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | Option 17 | description | string | The description of the widget. | | Option 17 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 17 | requests [*required*] | [object] | Request payload used to query items. | | requests | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | Option 17 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 17 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 17 | title | string | Title of the widget. | | Option 17 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 17 | title_size | string | Size of the title. | | Option 17 | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream` | | definition | Option 18 | object | The Log Stream displays a log flow matching the defined query. | | Option 18 | columns | [string] | Which columns to display on the widget. | | Option 18 | description | string | The description of the widget. | | Option 18 | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | Option 18 | logset | string | **DEPRECATED**: ID of the log set to use. | | Option 18 | message_display | enum | Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg` | | Option 18 | query | string | Query to filter the log stream with. | | Option 18 | show_date_column | boolean | Whether to show the date column or not | | Option 18 | show_message_column | boolean | Whether to show the message column or not | | Option 18 | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 18 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 18 | title | string | Title of the widget. | | Option 18 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 18 | title_size | string | Size of the title. | | Option 18 | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream` | | definition | Option 19 | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | Option 19 | color_preference | enum | Which color to use on the widget. Allowed enum values: `background,text` | | Option 19 | count | int64 | **DEPRECATED**: The number of monitors to display. | | Option 19 | description | string | The description of the widget. | | Option 19 | display_format | enum | What to display on the widget. Allowed enum values: `counts,countsAndList,list` | | Option 19 | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | Option 19 | query [*required*] | string | Query to filter the monitors with. | | Option 19 | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | Option 19 | show_priority | boolean | Whether to show the priorities column. | | Option 19 | sort | enum | Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc` | | Option 19 | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | Option 19 | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors,groups,combined` | | Option 19 | title | string | Title of the widget. | | Option 19 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 19 | title_size | string | Size of the title. | | Option 19 | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status` | | definition | Option 20 | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | Option 20 | background_color | string | Background color of the note. | | Option 20 | content [*required*] | string | Content of the note. | | Option 20 | font_size | string | Size of the text. | | Option 20 | has_padding | boolean | Whether to add padding or not. | | Option 20 | show_tick | boolean | Whether to show a tick or not. | | Option 20 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 20 | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top` | | Option 20 | tick_pos | string | Where to position the tick on an edge. | | Option 20 | type [*required*] | enum | Type of the note widget. Allowed enum values: `note` | | Option 20 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 21 | object | 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. | | Option 21 | background_color | string | Background color of the powerpack title. | | Option 21 | banner_img | string | URL of image to display as a banner for the powerpack. | | Option 21 | powerpack_id [*required*] | string | UUID of the associated powerpack. | | Option 21 | show_title | boolean | Whether to show the title or not. | | Option 21 | template_variables | object | Powerpack template variables. | | template_variables | controlled_by_powerpack | [object] | Template variables controlled at the powerpack level. | | controlled_by_powerpack | name [*required*] | string | The name of the variable. | | controlled_by_powerpack | prefix | string | The tag prefix associated with the variable. | | controlled_by_powerpack | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | template_variables | controlled_externally | [object] | Template variables controlled by the external resource, such as the dashboard this powerpack is on. | | controlled_externally | name [*required*] | string | The name of the variable. | | controlled_externally | prefix | string | The tag prefix associated with the variable. | | controlled_externally | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | Option 21 | title | string | Title of the widget. | | Option 21 | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack` | | definition | Option 22 | object | Query values display the current value of a given metric, APM, or log query. | | Option 22 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 22 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 22 | custom_unit | string | Display a unit of your choice on the widget. | | Option 22 | description | string | The description of the widget. | | Option 22 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 22 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 22 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 22 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 22 | title | string | Title of your widget. | | Option 22 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | title_size | string | Size of the title. | | Option 22 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | definition | Option 23 | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | Option 23 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 23 | description | string | The description of the widget. | | Option 23 | inputs | [object] | Array of workflow inputs to map to dashboard template variables. | | inputs | name [*required*] | string | Name of the workflow input. | | inputs | value [*required*] | string | Dashboard template variable. Can be suffixed with '.value' or '.key'. | | Option 23 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 23 | title | string | Title of your widget. | | Option 23 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 23 | title_size | string | Size of the title. | | Option 23 | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow` | | Option 23 | workflow_id [*required*] | string | Workflow id. | | definition | Option 24 | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | Option 24 | description | string | The description of the widget. | | Option 24 | requests [*required*] | [object] | Array of one request object to display in the widget. | | requests | query [*required*] | object | Updated SLO List widget. | | query | limit | int64 | Maximum number of results to display in the table. | | query | query_string [*required*] | string | Widget query. | | query | sort | [object] | Options for sorting results. | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `slo_list` | | Option 24 | title | string | Title of the widget. | | Option 24 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 24 | title_size | string | Size of the title. | | Option 24 | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list` | | definition | Option 25 | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | Option 25 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 25 | description | string | The description of the widget. | | Option 25 | global_time_target | string | Defined global time target. | | Option 25 | show_error_budget | boolean | Defined error budget. | | Option 25 | slo_id | string | ID of the SLO displayed. | | Option 25 | time_windows | [string] | Times being monitored. | | Option 25 | title | string | Title of the widget. | | Option 25 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 25 | title_size | string | Size of the title. | | Option 25 | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo` | | Option 25 | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both` | | Option 25 | view_type [*required*] | string | Type of view displayed by the widget. | | definition | Option 26 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 26 | color_by_groups | [string] | List of groups used for colors. | | Option 26 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 26 | description | string | The description of the widget. | | Option 26 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 26 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 26 | title | string | Title of your widget. | | Option 26 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 26 | title_size | string | Size of the title. | | Option 26 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 26 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 26 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 27 | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | Option 27 | requests [*required*] | [ ] | List of Sankey widget requests. | | requests | Option 1 | object | Sankey widget with RUM data source. | | Option 1 | query [*required*] | object | Sankey widget with RUM data source query. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | accounts | name | string | | accounts | query | string | | audience_filters | filter_condition | string | | audience_filters | segments | [object] | | segments | name | string | | segments | segment_id | string | | audience_filters | users | [object] | | users | name | string | | users | query | string | | query | data_source [*required*] | enum | Sankey widget with RUM data source. Allowed enum values: `rum,product_analytics` | | query | entries_per_step | int64 | Entries per step. | | query | join_keys | object | Join keys. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | query | mode [*required*] | enum | Sankey mode for RUM queries. Allowed enum values: `source,target` | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | | occurrences | operator | string | | occurrences | value | string | | query | query_string [*required*] | string | Query string. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | Option 1 | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | requests | Option 2 | object | Sankey widget request for network data source. | | Option 2 | query [*required*] | object | Query configuration for Sankey network widget. | | query | compute | object | Compute aggregation for network queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Option 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent` | | aggregation | Option 2 | string | Percentile aggregation. | | compute | metric [*required*] | string | Metric to aggregate. | | query | data_source [*required*] | enum | Network data source type. Allowed enum values: `network_device_flows,network` | | query | group_by [*required*] | [string] | Fields to group by. | | query | limit [*required*] | int64 | Maximum number of results. | | query | mode | enum | Sankey mode for network queries. Allowed enum values: `target` | | query | query_string [*required*] | string | Query string for filtering network data. | | query | should_exclude_missing | boolean | Whether to exclude missing values. | | query | sort | object | Sort configuration for network queries. | | sort | field | string | Field to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey` | | Option 27 | show_other_links | boolean | Whether to show links for "other" category. | | Option 27 | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | Option 27 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 27 | title | string | Title of your widget. | | Option 27 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 27 | title_size | string | Size of the title. | | Option 27 | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | definition | Option 28 | object | This widget displays a map of a service to all of the services that call it, and all of the services that it calls. | | Option 28 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 28 | description | string | The description of the widget. | | Option 28 | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | Option 28 | service [*required*] | string | The ID of the service you want to map. | | Option 28 | title | string | The title of your widget. | | Option 28 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 28 | title_size | string | Size of the title. | | Option 28 | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap` | | definition | Option 29 | object | The service summary displays the graphs of a chosen service in your dashboard. | | Option 29 | description | string | The description of the widget. | | Option 29 | display_format | enum | Number of columns to display. Allowed enum values: `one_column,two_column,three_column` | | Option 29 | env [*required*] | string | APM environment. | | Option 29 | service [*required*] | string | APM service. | | Option 29 | show_breakdown | boolean | Whether to show the latency breakdown or not. | | Option 29 | show_distribution | boolean | Whether to show the latency distribution or not. | | Option 29 | show_errors | boolean | Whether to show the error metrics or not. | | Option 29 | show_hits | boolean | Whether to show the hits metrics or not. | | Option 29 | show_latency | boolean | Whether to show the latency metrics or not. | | Option 29 | show_resource_list | boolean | Whether to show the resource list or not. | | Option 29 | size_format | enum | Size of the widget. Allowed enum values: `small,medium,large` | | Option 29 | span_name [*required*] | string | APM span name. | | Option 29 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 29 | title | string | Title of the widget. | | Option 29 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 29 | title_size | string | Size of the title. | | Option 29 | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service` | | definition | Option 30 | object | The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) | | Option 30 | has_uniform_y_axes | boolean | Normalize y axes across graphs | | Option 30 | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg` | | Option 30 | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | Option 1 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 1 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 1 | description | string | The description of the widget. | | Option 1 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 1 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | Title of your widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | source_widget_definition | Option 2 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 2 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 2 | description | string | The description of the widget. | | Option 2 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 2 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of the title. | | Option 2 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | source_widget_definition | Option 3 | object | This visualization displays a series of values by country on a world map. | | Option 3 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 3 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | The title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | The size of the title. | | Option 3 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 3 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | source_widget_definition | Option 4 | object | Query values display the current value of a given metric, APM, or log query. | | Option 4 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | custom_unit | string | Display a unit of your choice on the widget. | | Option 4 | description | string | The description of the widget. | | Option 4 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 4 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 4 | title | string | Title of your widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | source_widget_definition | Option 5 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 5 | color_by_groups | [string] | List of groups used for colors. | | Option 5 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 5 | description | string | The description of the widget. | | Option 5 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of your widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 5 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 5 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 6 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 6 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | hide_total | boolean | Show the total value in this widget. | | Option 6 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 6 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of your widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | source_widget_definition | Option 7 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 7 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 7 | description | string | The description of the widget. | | Option 7 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 7 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of your widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | source_widget_definition | Option 8 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 8 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 8 | description | string | The description of the widget. | | Option 8 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 8 | legend_columns | [string] | Columns displayed in the legend. | | Option 8 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 8 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 8 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 8 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 8 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 8 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of your widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 8 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 9 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 9 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 9 | description | string | The description of the widget. | | Option 9 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 9 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 9 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 9 | title | string | Title of your widget. | | Option 9 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | title_size | string | Size of the title. | | Option 9 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | source_widget_definition | Option 10 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 10 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 10 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 10 | description | string | The description of the widget. | | Option 10 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 10 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 10 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | Title of your widget. | | Option 10 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | Option 30 | split_config [*required*] | object | Encapsulates all user choices about how to split a graph. | | split_config | limit [*required*] | int64 | Maximum number of graphs to display in the widget. | | split_config | sort [*required*] | object | Controls the order in which graphs appear in the split. | | sort | compute | object | Defines the metric and aggregation used as the sort value. | | compute | aggregation [*required*] | string | How to aggregate the sort metric for the purposes of ordering. | | compute | metric [*required*] | string | The metric to use for sorting graphs. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | split_config | split_dimensions [*required*] | [object] | The dimension(s) on which to split the graph | | split_dimensions | one_graph_per [*required*] | string | The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. | | split_config | static_splits | [array] | Manual selection of tags making split graph widget static | | Option 30 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 30 | title | string | Title of your widget. | | Option 30 | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group` | | definition | Option 31 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 31 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 31 | description | string | The description of the widget. | | Option 31 | hide_total | boolean | Show the total value in this widget. | | Option 31 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 31 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 31 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 31 | title | string | Title of your widget. | | Option 31 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 31 | title_size | string | Size of the title. | | Option 31 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | definition | Option 32 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 32 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 32 | description | string | The description of the widget. | | Option 32 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 32 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 32 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 32 | title | string | Title of your widget. | | Option 32 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 32 | title_size | string | Size of the title. | | Option 32 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | definition | Option 33 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 33 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 33 | description | string | The description of the widget. | | Option 33 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 33 | legend_columns | [string] | Columns displayed in the legend. | | Option 33 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 33 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 33 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 33 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 33 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 33 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 33 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 33 | title | string | Title of your widget. | | Option 33 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 33 | title_size | string | Size of the title. | | Option 33 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 33 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 34 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 34 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 34 | description | string | The description of the widget. | | Option 34 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 34 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 34 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 34 | title | string | Title of your widget. | | Option 34 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 34 | title_size | string | Size of the title. | | Option 34 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | definition | Option 35 | object | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Option 35 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 35 | description | string | The description of the widget. | | Option 35 | requests [*required*] | [object] | One or more Topology requests. | | requests | query | object | Query to service-based topology data sources like the service map or data streams. | | query | data_source | enum | Name of the data source Allowed enum values: `data_streams,service_map` | | query | filters | [string] | Your environment and primary tag (or * if enabled for your account). | | query | service | string | Name of the service | | requests | request_type | enum | Widget request type. Allowed enum values: `topology` | | Option 35 | title | string | Title of your widget. | | Option 35 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 35 | title_size | string | Size of the title. | | Option 35 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map` | | definition | Option 36 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 36 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 36 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 36 | description | string | The description of the widget. | | Option 36 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 36 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 36 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 36 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 36 | title | string | Title of your widget. | | Option 36 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | definition | Option 37 | object | Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. | | Option 37 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 37 | requests [*required*] | [ ] | List of data requests for the wildcard widget. | | requests | Option 1 | object | An updated treemap widget. | | Option 1 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Option 1 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 1 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | Option 2 | object | Updated timeseries widget. | | Option 2 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | Option 2 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 2 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Option 2 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Option 2 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 2 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 2 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 2 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 2 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | requests | Option 3 | object | Updated list stream widget. | | Option 3 | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | Option 3 | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | Option 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | requests | Option 4 | object | Updated distribution widget. | | Option 4 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | Option 4 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 4 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 4 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 4 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 4 | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | Option 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | Option 4 | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | Option 4 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 37 | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See [https://vega.github.io/vega-lite/](https://vega.github.io/vega-lite/) for the full grammar reference. | | specification | contents [*required*] | object | The Vega or Vega-Lite JSON specification object. | | specification | type [*required*] | enum | Type of specification used by the wildcard widget. Allowed enum values: `vega,vega-lite` | | Option 37 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 37 | title | string | Title of the widget. | | Option 37 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 37 | title_size | string | Size of the title. | | Option 37 | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard` | | widgets | id | int64 | ID of the widget. | | widgets | layout | object | The layout for a widget on a `free` or **new dashboard layout** dashboard. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | is_column_break | boolean | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | {% /tab %} {% tab title="Example" %} ##### ```json { "title": "Example-Dashboard", "widgets": [ { "definition": { "title": "Example Cloud Cost Query", "title_size": "16", "title_align": "left", "type": "timeseries", "requests": [ { "formulas": [ { "formula": "query1" } ], "queries": [ { "data_source": "cloud_cost", "name": "query1", "query": "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)" } ], "response_format": "timeseries", "style": { "palette": "dog_classic", "line_type": "solid", "line_width": "normal" }, "display_type": "bars" } ], "time": {} } } ], "layout_type": "ordered" } ``` ##### ```json { "title": "Example-Dashboard", "description": "", "widgets": [ { "definition": { "title": "APM Stats - Request latency HOP", "title_size": "16", "title_align": "left", "show_legend": false, "type": "distribution", "xaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "yaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "requests": [ { "query": { "primary_tag_value": "*", "stat": "latency_distribution", "data_source": "apm_resource_stats", "name": "query1", "service": "azure-bill-import", "group_by": [ "resource_name" ], "env": "staging", "primary_tag_name": "datacenter", "operation_name": "universal.http.client" }, "request_type": "histogram", "style": { "palette": "dog_classic" } } ] }, "layout": { "x": 8, "y": 0, "width": 4, "height": 2 } } ], "layout_type": "ordered" } ``` ##### ```json { "title": "Example-Dashboard", "description": "Example-Dashboard", "widgets": [ { "definition": { "title": "Events Platform - Request latency HOP", "title_size": "16", "title_align": "left", "show_legend": false, "type": "distribution", "xaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "yaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "requests": [ { "query": { "search": { "query": "" }, "data_source": "events", "compute": { "metric": "@duration", "aggregation": "min" }, "name": "query1", "indexes": [ "*" ] }, "request_type": "histogram" } ] }, "layout": { "x": 0, "y": 0, "width": 4, "height": 2 } } ], "layout_type": "ordered" } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} 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. | Parent field | Field | Type | Description | | ------------------------- | ------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | author_handle | string | Identifier of the dashboard author. | | | author_name | string | Name of the dashboard author. | | | created_at | date-time | Creation date of the dashboard. | | | description | string | Description of the dashboard. | | | id | string | ID of the dashboard. | | | is_read_only | boolean | **DEPRECATED**: 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 [*required*] | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | | modified_at | date-time | Modification date of the dashboard. | | | notify_list | [string] | List of handles of users to notify when changes are made to this dashboard. | | | reflow_type | enum | 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. Allowed enum values: `auto,fixed` | | | 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 | [object] | List of tabs for organizing dashboard widgets into groups. | | tabs | id [*required*] | uuid | UUID of the tab. | | tabs | name [*required*] | string | Name of the tab. | | tabs | widget_ids [*required*] | [integer] | 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] | List of team names representing ownership of a dashboard. | | | template_variable_presets | [object] | Array of template variables saved views. | | template_variable_presets | name | string | The name of the variable. | | template_variable_presets | template_variables | [object] | List of variables. | | template_variables | name | string | The name of the variable. | | template_variables | value | string | **DEPRECATED**: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. | | template_variables | 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 | [object] | List of template variables for this dashboard. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. | | template_variables | 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`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | template_variables | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | | title [*required*] | string | Title of the dashboard. | | | url | string | The URL of the dashboard. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). | | definition | Option 1 | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | Option 1 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 1 | description | string | The description of the widget. | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | The title of the widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph` | | Option 1 | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist` | | definition | Option 2 | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | Option 2 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 2 | description | string | The description of the widget. | | Option 2 | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | Option 2 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of value in the widget. | | Option 2 | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value` | | Option 2 | unit | string | Unit to display with the value. | | definition | Option 3 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 3 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 3 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | Title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | Size of the title. | | Option 3 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | definition | Option 4 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | description | string | The description of the widget. | | Option 4 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | title | string | Title of the widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | definition | Option 5 | object | Check status shows the current status or number of results for any check performed. | | Option 5 | check [*required*] | string | Name of the check to use in the widget. | | Option 5 | description | string | The description of the widget. | | Option 5 | group | string | Group reporting a single check. | | Option 5 | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | Option 5 | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check,cluster` | | Option 5 | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of the widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status` | | definition | Option 6 | object | 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. | | Option 6 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 6 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | requests | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | requests | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of the widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution` | | Option 6 | xaxis | object | X Axis controls for the distribution widget. | | xaxis | include_zero | boolean | True includes zero. | | xaxis | max | string | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | min | string | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | num_buckets | int64 | Number of value buckets to target, also known as the resolution of the value bins. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`. | | Option 6 | yaxis | object | Y Axis controls for the distribution widget. | | yaxis | include_zero | boolean | True includes zero. | | yaxis | label | string | The label of the axis to display on the graph. | | yaxis | max | string | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. | | definition | Option 7 | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | Option 7 | description | string | The description of the widget. | | Option 7 | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | Option 7 | query [*required*] | string | Query to filter the event stream with. | | Option 7 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of the widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream` | | definition | Option 8 | object | 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. | | Option 8 | description | string | The description of the widget. | | Option 8 | query [*required*] | string | Query to filter the event timeline with. | | Option 8 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of the widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline` | | definition | Option 9 | object | Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. | | Option 9 | 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`. | | Option 9 | color | string | Color of the text. | | Option 9 | font_size | string | Size of the text. | | Option 9 | text [*required*] | string | Text to display. | | Option 9 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text` | | definition | Option 10 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Option 10 | description | string | The description of the widget. | | Option 10 | requests [*required*] | [object] | Request payload used to query items. | | requests | query [*required*] | object | Updated funnel widget. | | query | data_source [*required*] | enum | Source from which to query items to display in the funnel. Allowed enum values: `rum` | | query | query_string [*required*] | string | The widget query. | | query | steps [*required*] | [object] | List of funnel steps. | | steps | facet [*required*] | string | The facet of the step. | | steps | value [*required*] | string | The value of the step. | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `funnel` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | The title of the widget. | | Option 10 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 10 | title_size | string | The size of the title. | | Option 10 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel` | | definition | Option 11 | object | This visualization displays a series of values by country on a world map. | | Option 11 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 11 | description | string | The description of the widget. | | Option 11 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 11 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 11 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 11 | title | string | The title of your widget. | | Option 11 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 11 | title_size | string | The size of the title. | | Option 11 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 11 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | definition | Option 12 | object | 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. | | Option 12 | 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`. | | Option 12 | banner_img | string | URL of image to display as a banner for the group. | | Option 12 | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered` | | Option 12 | show_title | boolean | Whether to show the title or not. | | Option 12 | title | string | Title of the widget. | | Option 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 12 | type [*required*] | enum | Type of the group widget. Allowed enum values: `group` | | Option 12 | widgets [*required*] | [object] | List of widget groups. | | definition | Option 13 | object | 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. | | Option 13 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 13 | description | string | The description of the widget. | | Option 13 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 13 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 13 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 13 | requests [*required*] | [object] | List of widget types. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | search [*required*] | string | The query being made on the event. | | event_query | tags_execution [*required*] | string | The execution method for multi-value filters. Can be either and or or. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | A formula and functions metrics query. | | query | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | query | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | query | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | query | name [*required*] | string | Name of the query for use in formulas. | | query | query [*required*] | string | Metrics query definition. | | query | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | requests | request_type | enum | Applicable only for distribution of point values for distribution metrics. Allowed enum values: `histogram` | | requests | response_format | enum | Applicable only for distribution of aggregated grouped queries. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 13 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 13 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 13 | title | string | Title of the widget. | | Option 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 13 | title_size | string | Size of the title. | | Option 13 | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap` | | Option 13 | xaxis | object | X Axis controls for the heat map widget. | | xaxis | num_buckets | int64 | 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). | | Option 13 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 14 | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | Option 14 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 14 | description | string | The description of the widget. | | Option 14 | group | [string] | List of tag prefixes to group by. | | Option 14 | no_group_hosts | boolean | Whether to show the hosts that don't fit in a group. | | Option 14 | no_metric_hosts | boolean | Whether to show the hosts with no metrics. | | Option 14 | node_type | enum | Which type of node to use in the map. Allowed enum values: `host,container` | | Option 14 | notes | string | Notes on the title. | | Option 14 | requests [*required*] | object | List of definitions. | | requests | fill | object | Updated host map. | | fill | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | fill | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | q | string | Query definition. | | fill | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | size | object | Updated host map. | | size | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | size | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | q | string | Query definition. | | size | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 14 | scope | [string] | List of tags used to filter the map. | | Option 14 | style | object | The style to apply to the widget. | | style | fill_max | string | Max value to use to color the map. | | style | fill_min | string | Min value to use to color the map. | | style | palette | string | Color palette to apply to the widget. | | style | palette_flip | boolean | Whether to flip the palette tones. | | Option 14 | title | string | Title of the widget. | | Option 14 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 14 | title_size | string | Size of the title. | | Option 14 | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap` | | definition | Option 15 | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | Option 15 | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe` | | Option 15 | url [*required*] | string | URL of the iframe. | | definition | Option 16 | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | Option 16 | has_background | boolean | Whether to display a background or not. | | Option 16 | has_border | boolean | Whether to display a border or not. | | Option 16 | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center,left,right` | | Option 16 | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large` | | Option 16 | sizing | enum | 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. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center` | | Option 16 | type [*required*] | enum | Type of the image widget. Allowed enum values: `image` | | Option 16 | url [*required*] | string | URL of the image. | | Option 16 | url_dark_theme | string | URL of the image in dark mode. | | Option 16 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 17 | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | Option 17 | description | string | The description of the widget. | | Option 17 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 17 | requests [*required*] | [object] | Request payload used to query items. | | requests | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | Option 17 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 17 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 17 | title | string | Title of the widget. | | Option 17 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 17 | title_size | string | Size of the title. | | Option 17 | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream` | | definition | Option 18 | object | The Log Stream displays a log flow matching the defined query. | | Option 18 | columns | [string] | Which columns to display on the widget. | | Option 18 | description | string | The description of the widget. | | Option 18 | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | Option 18 | logset | string | **DEPRECATED**: ID of the log set to use. | | Option 18 | message_display | enum | Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg` | | Option 18 | query | string | Query to filter the log stream with. | | Option 18 | show_date_column | boolean | Whether to show the date column or not | | Option 18 | show_message_column | boolean | Whether to show the message column or not | | Option 18 | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 18 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 18 | title | string | Title of the widget. | | Option 18 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 18 | title_size | string | Size of the title. | | Option 18 | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream` | | definition | Option 19 | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | Option 19 | color_preference | enum | Which color to use on the widget. Allowed enum values: `background,text` | | Option 19 | count | int64 | **DEPRECATED**: The number of monitors to display. | | Option 19 | description | string | The description of the widget. | | Option 19 | display_format | enum | What to display on the widget. Allowed enum values: `counts,countsAndList,list` | | Option 19 | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | Option 19 | query [*required*] | string | Query to filter the monitors with. | | Option 19 | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | Option 19 | show_priority | boolean | Whether to show the priorities column. | | Option 19 | sort | enum | Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc` | | Option 19 | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | Option 19 | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors,groups,combined` | | Option 19 | title | string | Title of the widget. | | Option 19 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 19 | title_size | string | Size of the title. | | Option 19 | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status` | | definition | Option 20 | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | Option 20 | background_color | string | Background color of the note. | | Option 20 | content [*required*] | string | Content of the note. | | Option 20 | font_size | string | Size of the text. | | Option 20 | has_padding | boolean | Whether to add padding or not. | | Option 20 | show_tick | boolean | Whether to show a tick or not. | | Option 20 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 20 | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top` | | Option 20 | tick_pos | string | Where to position the tick on an edge. | | Option 20 | type [*required*] | enum | Type of the note widget. Allowed enum values: `note` | | Option 20 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 21 | object | 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. | | Option 21 | background_color | string | Background color of the powerpack title. | | Option 21 | banner_img | string | URL of image to display as a banner for the powerpack. | | Option 21 | powerpack_id [*required*] | string | UUID of the associated powerpack. | | Option 21 | show_title | boolean | Whether to show the title or not. | | Option 21 | template_variables | object | Powerpack template variables. | | template_variables | controlled_by_powerpack | [object] | Template variables controlled at the powerpack level. | | controlled_by_powerpack | name [*required*] | string | The name of the variable. | | controlled_by_powerpack | prefix | string | The tag prefix associated with the variable. | | controlled_by_powerpack | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | template_variables | controlled_externally | [object] | Template variables controlled by the external resource, such as the dashboard this powerpack is on. | | controlled_externally | name [*required*] | string | The name of the variable. | | controlled_externally | prefix | string | The tag prefix associated with the variable. | | controlled_externally | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | Option 21 | title | string | Title of the widget. | | Option 21 | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack` | | definition | Option 22 | object | Query values display the current value of a given metric, APM, or log query. | | Option 22 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 22 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 22 | custom_unit | string | Display a unit of your choice on the widget. | | Option 22 | description | string | The description of the widget. | | Option 22 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 22 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 22 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 22 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 22 | title | string | Title of your widget. | | Option 22 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | title_size | string | Size of the title. | | Option 22 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | definition | Option 23 | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | Option 23 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 23 | description | string | The description of the widget. | | Option 23 | inputs | [object] | Array of workflow inputs to map to dashboard template variables. | | inputs | name [*required*] | string | Name of the workflow input. | | inputs | value [*required*] | string | Dashboard template variable. Can be suffixed with '.value' or '.key'. | | Option 23 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 23 | title | string | Title of your widget. | | Option 23 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 23 | title_size | string | Size of the title. | | Option 23 | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow` | | Option 23 | workflow_id [*required*] | string | Workflow id. | | definition | Option 24 | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | Option 24 | description | string | The description of the widget. | | Option 24 | requests [*required*] | [object] | Array of one request object to display in the widget. | | requests | query [*required*] | object | Updated SLO List widget. | | query | limit | int64 | Maximum number of results to display in the table. | | query | query_string [*required*] | string | Widget query. | | query | sort | [object] | Options for sorting results. | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `slo_list` | | Option 24 | title | string | Title of the widget. | | Option 24 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 24 | title_size | string | Size of the title. | | Option 24 | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list` | | definition | Option 25 | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | Option 25 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 25 | description | string | The description of the widget. | | Option 25 | global_time_target | string | Defined global time target. | | Option 25 | show_error_budget | boolean | Defined error budget. | | Option 25 | slo_id | string | ID of the SLO displayed. | | Option 25 | time_windows | [string] | Times being monitored. | | Option 25 | title | string | Title of the widget. | | Option 25 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 25 | title_size | string | Size of the title. | | Option 25 | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo` | | Option 25 | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both` | | Option 25 | view_type [*required*] | string | Type of view displayed by the widget. | | definition | Option 26 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 26 | color_by_groups | [string] | List of groups used for colors. | | Option 26 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 26 | description | string | The description of the widget. | | Option 26 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 26 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 26 | title | string | Title of your widget. | | Option 26 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 26 | title_size | string | Size of the title. | | Option 26 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 26 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 26 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 27 | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | Option 27 | requests [*required*] | [ ] | List of Sankey widget requests. | | requests | Option 1 | object | Sankey widget with RUM data source. | | Option 1 | query [*required*] | object | Sankey widget with RUM data source query. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | accounts | name | string | | accounts | query | string | | audience_filters | filter_condition | string | | audience_filters | segments | [object] | | segments | name | string | | segments | segment_id | string | | audience_filters | users | [object] | | users | name | string | | users | query | string | | query | data_source [*required*] | enum | Sankey widget with RUM data source. Allowed enum values: `rum,product_analytics` | | query | entries_per_step | int64 | Entries per step. | | query | join_keys | object | Join keys. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | query | mode [*required*] | enum | Sankey mode for RUM queries. Allowed enum values: `source,target` | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | | occurrences | operator | string | | occurrences | value | string | | query | query_string [*required*] | string | Query string. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | Option 1 | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | requests | Option 2 | object | Sankey widget request for network data source. | | Option 2 | query [*required*] | object | Query configuration for Sankey network widget. | | query | compute | object | Compute aggregation for network queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Option 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent` | | aggregation | Option 2 | string | Percentile aggregation. | | compute | metric [*required*] | string | Metric to aggregate. | | query | data_source [*required*] | enum | Network data source type. Allowed enum values: `network_device_flows,network` | | query | group_by [*required*] | [string] | Fields to group by. | | query | limit [*required*] | int64 | Maximum number of results. | | query | mode | enum | Sankey mode for network queries. Allowed enum values: `target` | | query | query_string [*required*] | string | Query string for filtering network data. | | query | should_exclude_missing | boolean | Whether to exclude missing values. | | query | sort | object | Sort configuration for network queries. | | sort | field | string | Field to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey` | | Option 27 | show_other_links | boolean | Whether to show links for "other" category. | | Option 27 | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | Option 27 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 27 | title | string | Title of your widget. | | Option 27 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 27 | title_size | string | Size of the title. | | Option 27 | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | definition | Option 28 | object | This widget displays a map of a service to all of the services that call it, and all of the services that it calls. | | Option 28 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 28 | description | string | The description of the widget. | | Option 28 | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | Option 28 | service [*required*] | string | The ID of the service you want to map. | | Option 28 | title | string | The title of your widget. | | Option 28 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 28 | title_size | string | Size of the title. | | Option 28 | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap` | | definition | Option 29 | object | The service summary displays the graphs of a chosen service in your dashboard. | | Option 29 | description | string | The description of the widget. | | Option 29 | display_format | enum | Number of columns to display. Allowed enum values: `one_column,two_column,three_column` | | Option 29 | env [*required*] | string | APM environment. | | Option 29 | service [*required*] | string | APM service. | | Option 29 | show_breakdown | boolean | Whether to show the latency breakdown or not. | | Option 29 | show_distribution | boolean | Whether to show the latency distribution or not. | | Option 29 | show_errors | boolean | Whether to show the error metrics or not. | | Option 29 | show_hits | boolean | Whether to show the hits metrics or not. | | Option 29 | show_latency | boolean | Whether to show the latency metrics or not. | | Option 29 | show_resource_list | boolean | Whether to show the resource list or not. | | Option 29 | size_format | enum | Size of the widget. Allowed enum values: `small,medium,large` | | Option 29 | span_name [*required*] | string | APM span name. | | Option 29 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 29 | title | string | Title of the widget. | | Option 29 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 29 | title_size | string | Size of the title. | | Option 29 | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service` | | definition | Option 30 | object | The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) | | Option 30 | has_uniform_y_axes | boolean | Normalize y axes across graphs | | Option 30 | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg` | | Option 30 | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | Option 1 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 1 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 1 | description | string | The description of the widget. | | Option 1 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 1 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | Title of your widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | source_widget_definition | Option 2 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 2 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 2 | description | string | The description of the widget. | | Option 2 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 2 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of the title. | | Option 2 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | source_widget_definition | Option 3 | object | This visualization displays a series of values by country on a world map. | | Option 3 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 3 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | The title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | The size of the title. | | Option 3 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 3 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | source_widget_definition | Option 4 | object | Query values display the current value of a given metric, APM, or log query. | | Option 4 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | custom_unit | string | Display a unit of your choice on the widget. | | Option 4 | description | string | The description of the widget. | | Option 4 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 4 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 4 | title | string | Title of your widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | source_widget_definition | Option 5 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 5 | color_by_groups | [string] | List of groups used for colors. | | Option 5 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 5 | description | string | The description of the widget. | | Option 5 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of your widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 5 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 5 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 6 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 6 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | hide_total | boolean | Show the total value in this widget. | | Option 6 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 6 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of your widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | source_widget_definition | Option 7 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 7 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 7 | description | string | The description of the widget. | | Option 7 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 7 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of your widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | source_widget_definition | Option 8 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 8 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 8 | description | string | The description of the widget. | | Option 8 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 8 | legend_columns | [string] | Columns displayed in the legend. | | Option 8 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 8 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 8 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 8 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 8 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 8 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of your widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 8 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 9 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 9 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 9 | description | string | The description of the widget. | | Option 9 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 9 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 9 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 9 | title | string | Title of your widget. | | Option 9 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | title_size | string | Size of the title. | | Option 9 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | source_widget_definition | Option 10 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 10 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 10 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 10 | description | string | The description of the widget. | | Option 10 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 10 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 10 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | Title of your widget. | | Option 10 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | Option 30 | split_config [*required*] | object | Encapsulates all user choices about how to split a graph. | | split_config | limit [*required*] | int64 | Maximum number of graphs to display in the widget. | | split_config | sort [*required*] | object | Controls the order in which graphs appear in the split. | | sort | compute | object | Defines the metric and aggregation used as the sort value. | | compute | aggregation [*required*] | string | How to aggregate the sort metric for the purposes of ordering. | | compute | metric [*required*] | string | The metric to use for sorting graphs. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | split_config | split_dimensions [*required*] | [object] | The dimension(s) on which to split the graph | | split_dimensions | one_graph_per [*required*] | string | The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. | | split_config | static_splits | [array] | Manual selection of tags making split graph widget static | | Option 30 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 30 | title | string | Title of your widget. | | Option 30 | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group` | | definition | Option 31 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 31 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 31 | description | string | The description of the widget. | | Option 31 | hide_total | boolean | Show the total value in this widget. | | Option 31 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 31 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 31 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 31 | title | string | Title of your widget. | | Option 31 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 31 | title_size | string | Size of the title. | | Option 31 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | definition | Option 32 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 32 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 32 | description | string | The description of the widget. | | Option 32 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 32 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 32 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 32 | title | string | Title of your widget. | | Option 32 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 32 | title_size | string | Size of the title. | | Option 32 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | definition | Option 33 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 33 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 33 | description | string | The description of the widget. | | Option 33 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 33 | legend_columns | [string] | Columns displayed in the legend. | | Option 33 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 33 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 33 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 33 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 33 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 33 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 33 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 33 | title | string | Title of your widget. | | Option 33 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 33 | title_size | string | Size of the title. | | Option 33 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 33 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 34 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 34 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 34 | description | string | The description of the widget. | | Option 34 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 34 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 34 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 34 | title | string | Title of your widget. | | Option 34 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 34 | title_size | string | Size of the title. | | Option 34 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | definition | Option 35 | object | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Option 35 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 35 | description | string | The description of the widget. | | Option 35 | requests [*required*] | [object] | One or more Topology requests. | | requests | query | object | Query to service-based topology data sources like the service map or data streams. | | query | data_source | enum | Name of the data source Allowed enum values: `data_streams,service_map` | | query | filters | [string] | Your environment and primary tag (or * if enabled for your account). | | query | service | string | Name of the service | | requests | request_type | enum | Widget request type. Allowed enum values: `topology` | | Option 35 | title | string | Title of your widget. | | Option 35 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 35 | title_size | string | Size of the title. | | Option 35 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map` | | definition | Option 36 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 36 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 36 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 36 | description | string | The description of the widget. | | Option 36 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 36 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 36 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 36 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 36 | title | string | Title of your widget. | | Option 36 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | definition | Option 37 | object | Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. | | Option 37 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 37 | requests [*required*] | [ ] | List of data requests for the wildcard widget. | | requests | Option 1 | object | An updated treemap widget. | | Option 1 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Option 1 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 1 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | Option 2 | object | Updated timeseries widget. | | Option 2 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | Option 2 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 2 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Option 2 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Option 2 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 2 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 2 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 2 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 2 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | requests | Option 3 | object | Updated list stream widget. | | Option 3 | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | Option 3 | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | Option 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | requests | Option 4 | object | Updated distribution widget. | | Option 4 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | Option 4 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 4 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 4 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 4 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 4 | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | Option 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | Option 4 | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | Option 4 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 37 | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See [https://vega.github.io/vega-lite/](https://vega.github.io/vega-lite/) for the full grammar reference. | | specification | contents [*required*] | object | The Vega or Vega-Lite JSON specification object. | | specification | type [*required*] | enum | Type of specification used by the wildcard widget. Allowed enum values: `vega,vega-lite` | | Option 37 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 37 | title | string | Title of the widget. | | Option 37 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 37 | title_size | string | Size of the title. | | Option 37 | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard` | | widgets | id | int64 | ID of the widget. | | widgets | layout | object | The layout for a widget on a `free` or **new dashboard layout** dashboard. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | is_column_break | boolean | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | {% /tab %} {% tab title="Example" %} ```json { "author_handle": "test@datadoghq.com", "author_name": "John Doe", "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "id": "123-abc-456", "is_read_only": false, "layout_type": "ordered", "modified_at": "2019-09-19T10:00:00.000Z", "notify_list": [], "reflow_type": "string", "restricted_roles": [], "tabs": [ { "id": "", "name": "L", "widget_ids": [ 0 ] } ], "tags": [], "template_variable_presets": [ { "name": "string", "template_variables": [ { "name": "string", "value": "string", "values": [] } ] } ], "template_variables": [ { "available_values": [ "my-host", "host1", "host2" ], "default": "my-host", "defaults": [ "my-host-1", "my-host-2" ], "name": "host1", "prefix": "host", "type": "group" } ], "title": "", "url": "/dashboard/123-abc-456/example-dashboard-title", "widgets": [ { "definition": { "requests": { "fill": { "q": "avg:system.cpu.user{*}" } }, "type": "hostmap" }, "id": "integer", "layout": { "height": 0, "is_column_break": false, "width": 0, "x": 0, "y": 0 } } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "title": "Example-Dashboard", "widgets": [ { "definition": { "title": "Example Cloud Cost Query", "title_size": "16", "title_align": "left", "type": "timeseries", "requests": [ { "formulas": [ { "formula": "query1" } ], "queries": [ { "data_source": "cloud_cost", "name": "query1", "query": "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)" } ], "response_format": "timeseries", "style": { "palette": "dog_classic", "line_type": "solid", "line_width": "normal" }, "display_type": "bars" } ], "time": {} } } ], "layout_type": "ordered" } EOF ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "title": "Example-Dashboard", "description": "", "widgets": [ { "definition": { "title": "APM Stats - Request latency HOP", "title_size": "16", "title_align": "left", "show_legend": false, "type": "distribution", "xaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "yaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "requests": [ { "query": { "primary_tag_value": "*", "stat": "latency_distribution", "data_source": "apm_resource_stats", "name": "query1", "service": "azure-bill-import", "group_by": [ "resource_name" ], "env": "staging", "primary_tag_name": "datacenter", "operation_name": "universal.http.client" }, "request_type": "histogram", "style": { "palette": "dog_classic" } } ] }, "layout": { "x": 8, "y": 0, "width": 4, "height": 2 } } ], "layout_type": "ordered" } EOF ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "title": "Example-Dashboard", "description": "Example-Dashboard", "widgets": [ { "definition": { "title": "Events Platform - Request latency HOP", "title_size": "16", "title_align": "left", "show_legend": false, "type": "distribution", "xaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "yaxis": { "max": "auto", "include_zero": true, "scale": "linear", "min": "auto" }, "requests": [ { "query": { "search": { "query": "" }, "data_source": "events", "compute": { "metric": "@duration", "aggregation": "min" }, "name": "query1", "indexes": [ "*" ] }, "request_type": "histogram" } ] }, "layout": { "x": 0, "y": 0, "width": 4, "height": 2 } } ], "layout_type": "ordered" } EOF ##### ```go // Clients deserialize a dashboard with a empty time object package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { body := datadogV1.Dashboard{ Title: "Example-Dashboard", Widgets: []datadogV1.Widget{ { Definition: datadogV1.WidgetDefinition{ TimeseriesWidgetDefinition: &datadogV1.TimeseriesWidgetDefinition{ Title: datadog.PtrString("Example Cloud Cost Query"), TitleSize: datadog.PtrString("16"), TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(), Type: datadogV1.TIMESERIESWIDGETDEFINITIONTYPE_TIMESERIES, Requests: []datadogV1.TimeseriesWidgetRequest{ { Formulas: []datadogV1.WidgetFormula{ { Formula: "query1", }, }, Queries: []datadogV1.FormulaAndFunctionQueryDefinition{ datadogV1.FormulaAndFunctionQueryDefinition{ FormulaAndFunctionCloudCostQueryDefinition: &datadogV1.FormulaAndFunctionCloudCostQueryDefinition{ DataSource: datadogV1.FORMULAANDFUNCTIONCLOUDCOSTDATASOURCE_CLOUD_COST, Name: "query1", Query: "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)", }}, }, ResponseFormat: datadogV1.FORMULAANDFUNCTIONRESPONSEFORMAT_TIMESERIES.Ptr(), Style: &datadogV1.WidgetRequestStyle{ Palette: datadog.PtrString("dog_classic"), LineType: datadogV1.WIDGETLINETYPE_SOLID.Ptr(), LineWidth: datadogV1.WIDGETLINEWIDTH_NORMAL.Ptr(), }, DisplayType: datadogV1.WIDGETDISPLAYTYPE_BARS.Ptr(), }, }, Time: &datadogV1.WidgetTime{ WidgetLegacyLiveSpan: &datadogV1.WidgetLegacyLiveSpan{}}, }}, }, }, LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.CreateDashboard(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent) } ``` ##### ```go // Create a distribution widget using a histogram request containing a formulas and functions APM Stats query package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { body := datadogV1.Dashboard{ Title: "Example-Dashboard", Description: *datadog.NewNullableString(datadog.PtrString("")), Widgets: []datadogV1.Widget{ { Definition: datadogV1.WidgetDefinition{ DistributionWidgetDefinition: &datadogV1.DistributionWidgetDefinition{ Title: datadog.PtrString("APM Stats - Request latency HOP"), TitleSize: datadog.PtrString("16"), TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(), ShowLegend: datadog.PtrBool(false), Type: datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION, Xaxis: &datadogV1.DistributionWidgetXAxis{ Max: datadog.PtrString("auto"), IncludeZero: datadog.PtrBool(true), Scale: datadog.PtrString("linear"), Min: datadog.PtrString("auto"), }, Yaxis: &datadogV1.DistributionWidgetYAxis{ Max: datadog.PtrString("auto"), IncludeZero: datadog.PtrBool(true), Scale: datadog.PtrString("linear"), Min: datadog.PtrString("auto"), }, Requests: []datadogV1.DistributionWidgetRequest{ { Query: &datadogV1.DistributionWidgetHistogramRequestQuery{ FormulaAndFunctionApmResourceStatsQueryDefinition: &datadogV1.FormulaAndFunctionApmResourceStatsQueryDefinition{ PrimaryTagValue: datadog.PtrString("*"), Stat: datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATNAME_LATENCY_DISTRIBUTION, DataSource: datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATSDATASOURCE_APM_RESOURCE_STATS, Name: "query1", Service: "azure-bill-import", GroupBy: []string{ "resource_name", }, Env: "staging", PrimaryTagName: datadog.PtrString("datacenter"), OperationName: datadog.PtrString("universal.http.client"), }}, RequestType: datadogV1.WIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(), Style: &datadogV1.WidgetStyle{ Palette: datadog.PtrString("dog_classic"), }, }, }, }}, Layout: &datadogV1.WidgetLayout{ X: 8, Y: 0, Width: 4, Height: 2, }, }, }, LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.CreateDashboard(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent) } ``` ##### ```go // Create a distribution widget using a histogram request containing a formulas and functions events query package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { body := datadogV1.Dashboard{ Title: "Example-Dashboard", Description: *datadog.NewNullableString(datadog.PtrString("Example-Dashboard")), Widgets: []datadogV1.Widget{ { Definition: datadogV1.WidgetDefinition{ DistributionWidgetDefinition: &datadogV1.DistributionWidgetDefinition{ Title: datadog.PtrString("Events Platform - Request latency HOP"), TitleSize: datadog.PtrString("16"), TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(), ShowLegend: datadog.PtrBool(false), Type: datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION, Xaxis: &datadogV1.DistributionWidgetXAxis{ Max: datadog.PtrString("auto"), IncludeZero: datadog.PtrBool(true), Scale: datadog.PtrString("linear"), Min: datadog.PtrString("auto"), }, Yaxis: &datadogV1.DistributionWidgetYAxis{ Max: datadog.PtrString("auto"), IncludeZero: datadog.PtrBool(true), Scale: datadog.PtrString("linear"), Min: datadog.PtrString("auto"), }, Requests: []datadogV1.DistributionWidgetRequest{ { Query: &datadogV1.DistributionWidgetHistogramRequestQuery{ FormulaAndFunctionEventQueryDefinition: &datadogV1.FormulaAndFunctionEventQueryDefinition{ Search: &datadogV1.FormulaAndFunctionEventQueryDefinitionSearch{ Query: "", }, DataSource: datadogV1.FORMULAANDFUNCTIONEVENTSDATASOURCE_EVENTS, Compute: datadogV1.FormulaAndFunctionEventQueryDefinitionCompute{ Metric: datadog.PtrString("@duration"), Aggregation: datadogV1.FORMULAANDFUNCTIONEVENTAGGREGATION_MIN, }, Name: "query1", Indexes: []string{ "*", }, GroupBy: []datadogV1.FormulaAndFunctionEventQueryGroupBy{}, }}, RequestType: datadogV1.WIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(), }, }, }}, Layout: &datadogV1.WidgetLayout{ X: 0, Y: 0, Width: 4, Height: 2, }, }, }, LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.CreateDashboard(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Clients deserialize a dashboard with a empty time object import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; import com.datadog.api.client.v1.model.DashboardLayoutType; import com.datadog.api.client.v1.model.FormulaAndFunctionCloudCostDataSource; import com.datadog.api.client.v1.model.FormulaAndFunctionCloudCostQueryDefinition; import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition; import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat; import com.datadog.api.client.v1.model.TimeseriesWidgetDefinition; import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType; import com.datadog.api.client.v1.model.TimeseriesWidgetRequest; import com.datadog.api.client.v1.model.Widget; import com.datadog.api.client.v1.model.WidgetDefinition; import com.datadog.api.client.v1.model.WidgetDisplayType; import com.datadog.api.client.v1.model.WidgetFormula; import com.datadog.api.client.v1.model.WidgetLegacyLiveSpan; import com.datadog.api.client.v1.model.WidgetLineType; import com.datadog.api.client.v1.model.WidgetLineWidth; import com.datadog.api.client.v1.model.WidgetRequestStyle; import com.datadog.api.client.v1.model.WidgetTextAlign; import com.datadog.api.client.v1.model.WidgetTime; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); Dashboard body = new Dashboard() .title("Example-Dashboard") .widgets( Collections.singletonList( new Widget() .definition( new WidgetDefinition( new TimeseriesWidgetDefinition() .title("Example Cloud Cost Query") .titleSize("16") .titleAlign(WidgetTextAlign.LEFT) .type(TimeseriesWidgetDefinitionType.TIMESERIES) .requests( Collections.singletonList( new TimeseriesWidgetRequest() .formulas( Collections.singletonList( new WidgetFormula().formula("query1"))) .queries( Collections.singletonList( new FormulaAndFunctionQueryDefinition( new FormulaAndFunctionCloudCostQueryDefinition() .dataSource( FormulaAndFunctionCloudCostDataSource .CLOUD_COST) .name("query1") .query( "sum:aws.cost.amortized{*} by" + " {aws_product}.rollup(sum," + " monthly)")))) .responseFormat( FormulaAndFunctionResponseFormat.TIMESERIES) .style( new WidgetRequestStyle() .palette("dog_classic") .lineType(WidgetLineType.SOLID) .lineWidth(WidgetLineWidth.NORMAL)) .displayType(WidgetDisplayType.BARS))) .time(new WidgetTime(new WidgetLegacyLiveSpan())))))) .layoutType(DashboardLayoutType.ORDERED); try { Dashboard result = apiInstance.createDashboard(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#createDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Create a distribution widget using a histogram request containing a formulas and functions APM // Stats query import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; import com.datadog.api.client.v1.model.DashboardLayoutType; import com.datadog.api.client.v1.model.DistributionWidgetDefinition; import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType; import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery; import com.datadog.api.client.v1.model.DistributionWidgetRequest; import com.datadog.api.client.v1.model.DistributionWidgetXAxis; import com.datadog.api.client.v1.model.DistributionWidgetYAxis; import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatName; import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsDataSource; import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsQueryDefinition; import com.datadog.api.client.v1.model.Widget; import com.datadog.api.client.v1.model.WidgetDefinition; import com.datadog.api.client.v1.model.WidgetHistogramRequestType; import com.datadog.api.client.v1.model.WidgetLayout; import com.datadog.api.client.v1.model.WidgetStyle; import com.datadog.api.client.v1.model.WidgetTextAlign; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); Dashboard body = new Dashboard() .title("Example-Dashboard") .description("") .widgets( Collections.singletonList( new Widget() .definition( new WidgetDefinition( new DistributionWidgetDefinition() .title("APM Stats - Request latency HOP") .titleSize("16") .titleAlign(WidgetTextAlign.LEFT) .showLegend(false) .type(DistributionWidgetDefinitionType.DISTRIBUTION) .xaxis( new DistributionWidgetXAxis() .max("auto") .includeZero(true) .scale("linear") .min("auto")) .yaxis( new DistributionWidgetYAxis() .max("auto") .includeZero(true) .scale("linear") .min("auto")) .requests( Collections.singletonList( new DistributionWidgetRequest() .query( new DistributionWidgetHistogramRequestQuery( new FormulaAndFunctionApmResourceStatsQueryDefinition() .primaryTagValue("*") .stat( FormulaAndFunctionApmResourceStatName .LATENCY_DISTRIBUTION) .dataSource( FormulaAndFunctionApmResourceStatsDataSource .APM_RESOURCE_STATS) .name("query1") .service("azure-bill-import") .groupBy( Collections.singletonList( "resource_name")) .env("staging") .primaryTagName("datacenter") .operationName( "universal.http.client"))) .requestType(WidgetHistogramRequestType.HISTOGRAM) .style(new WidgetStyle().palette("dog_classic")))))) .layout(new WidgetLayout().x(8L).y(0L).width(4L).height(2L)))) .layoutType(DashboardLayoutType.ORDERED); try { Dashboard result = apiInstance.createDashboard(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#createDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Create a distribution widget using a histogram request containing a formulas and functions events // query import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; import com.datadog.api.client.v1.model.DashboardLayoutType; import com.datadog.api.client.v1.model.DistributionWidgetDefinition; import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType; import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery; import com.datadog.api.client.v1.model.DistributionWidgetRequest; import com.datadog.api.client.v1.model.DistributionWidgetXAxis; import com.datadog.api.client.v1.model.DistributionWidgetYAxis; import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation; import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition; import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute; import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch; import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource; import com.datadog.api.client.v1.model.Widget; import com.datadog.api.client.v1.model.WidgetDefinition; import com.datadog.api.client.v1.model.WidgetHistogramRequestType; import com.datadog.api.client.v1.model.WidgetLayout; import com.datadog.api.client.v1.model.WidgetTextAlign; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); Dashboard body = new Dashboard() .title("Example-Dashboard") .description("Example-Dashboard") .widgets( Collections.singletonList( new Widget() .definition( new WidgetDefinition( new DistributionWidgetDefinition() .title("Events Platform - Request latency HOP") .titleSize("16") .titleAlign(WidgetTextAlign.LEFT) .showLegend(false) .type(DistributionWidgetDefinitionType.DISTRIBUTION) .xaxis( new DistributionWidgetXAxis() .max("auto") .includeZero(true) .scale("linear") .min("auto")) .yaxis( new DistributionWidgetYAxis() .max("auto") .includeZero(true) .scale("linear") .min("auto")) .requests( Collections.singletonList( new DistributionWidgetRequest() .query( new DistributionWidgetHistogramRequestQuery( new FormulaAndFunctionEventQueryDefinition() .search( new FormulaAndFunctionEventQueryDefinitionSearch() .query("")) .dataSource( FormulaAndFunctionEventsDataSource .EVENTS) .compute( new FormulaAndFunctionEventQueryDefinitionCompute() .metric("@duration") .aggregation( FormulaAndFunctionEventAggregation .MIN)) .name("query1") .indexes( Collections.singletonList("*")))) .requestType( WidgetHistogramRequestType.HISTOGRAM))))) .layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L)))) .layoutType(DashboardLayoutType.ORDERED); try { Dashboard result = apiInstance.createDashboard(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#createDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) title = 'Average Memory Free Shell' widgets = [{ 'definition': { 'type': 'timeseries', 'requests': [ {'q': 'avg:system.mem.free{*}'} ], 'title': 'Average Memory Free' } }] layout_type = 'ordered' description = 'A dashboard with memory info.' is_read_only = True notify_list = ['user@domain.com'] template_variables = [{ 'name': 'host1', 'prefix': 'host', 'default': 'my-host' }] saved_views = [{ 'name': 'Saved views for hostname 2', 'template_variables': [{'name': 'host', 'value': ''}]} ] api.Dashboard.create(title=title, widgets=widgets, layout_type=layout_type, description=description, is_read_only=is_read_only, notify_list=notify_list, template_variables=template_variables, template_variable_presets=saved_view) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ##### ```python """ Clients deserialize a dashboard with a empty time object """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard import Dashboard from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType from datadog_api_client.v1.model.formula_and_function_cloud_cost_data_source import ( FormulaAndFunctionCloudCostDataSource, ) from datadog_api_client.v1.model.formula_and_function_cloud_cost_query_definition import ( FormulaAndFunctionCloudCostQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest from datadog_api_client.v1.model.widget import Widget from datadog_api_client.v1.model.widget_display_type import WidgetDisplayType from datadog_api_client.v1.model.widget_formula import WidgetFormula from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan from datadog_api_client.v1.model.widget_line_type import WidgetLineType from datadog_api_client.v1.model.widget_line_width import WidgetLineWidth from datadog_api_client.v1.model.widget_request_style import WidgetRequestStyle from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign body = Dashboard( title="Example-Dashboard", widgets=[ Widget( definition=TimeseriesWidgetDefinition( title="Example Cloud Cost Query", title_size="16", title_align=WidgetTextAlign.LEFT, type=TimeseriesWidgetDefinitionType.TIMESERIES, requests=[ TimeseriesWidgetRequest( formulas=[ WidgetFormula( formula="query1", ), ], queries=[ FormulaAndFunctionCloudCostQueryDefinition( data_source=FormulaAndFunctionCloudCostDataSource.CLOUD_COST, name="query1", query="sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)", ), ], response_format=FormulaAndFunctionResponseFormat.TIMESERIES, style=WidgetRequestStyle( palette="dog_classic", line_type=WidgetLineType.SOLID, line_width=WidgetLineWidth.NORMAL, ), display_type=WidgetDisplayType.BARS, ), ], time=WidgetLegacyLiveSpan(), ), ), ], layout_type=DashboardLayoutType.ORDERED, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.create_dashboard(body=body) print(response) ``` ##### ```python """ Create a distribution widget using a histogram request containing a formulas and functions APM Stats query """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard import Dashboard from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis from datadog_api_client.v1.model.formula_and_function_apm_resource_stat_name import ( FormulaAndFunctionApmResourceStatName, ) from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_data_source import ( FormulaAndFunctionApmResourceStatsDataSource, ) from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_query_definition import ( FormulaAndFunctionApmResourceStatsQueryDefinition, ) from datadog_api_client.v1.model.widget import Widget from datadog_api_client.v1.model.widget_histogram_request_type import WidgetHistogramRequestType from datadog_api_client.v1.model.widget_layout import WidgetLayout from datadog_api_client.v1.model.widget_style import WidgetStyle from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign body = Dashboard( title="Example-Dashboard", description="", widgets=[ Widget( definition=DistributionWidgetDefinition( title="APM Stats - Request latency HOP", title_size="16", title_align=WidgetTextAlign.LEFT, show_legend=False, type=DistributionWidgetDefinitionType.DISTRIBUTION, xaxis=DistributionWidgetXAxis( max="auto", include_zero=True, scale="linear", min="auto", ), yaxis=DistributionWidgetYAxis( max="auto", include_zero=True, scale="linear", min="auto", ), requests=[ DistributionWidgetRequest( query=FormulaAndFunctionApmResourceStatsQueryDefinition( primary_tag_value="*", stat=FormulaAndFunctionApmResourceStatName.LATENCY_DISTRIBUTION, data_source=FormulaAndFunctionApmResourceStatsDataSource.APM_RESOURCE_STATS, name="query1", service="azure-bill-import", group_by=[ "resource_name", ], env="staging", primary_tag_name="datacenter", operation_name="universal.http.client", ), request_type=WidgetHistogramRequestType.HISTOGRAM, style=WidgetStyle( palette="dog_classic", ), ), ], ), layout=WidgetLayout( x=8, y=0, width=4, height=2, ), ), ], layout_type=DashboardLayoutType.ORDERED, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.create_dashboard(body=body) print(response) ``` ##### ```python """ Create a distribution widget using a histogram request containing a formulas and functions events query """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard import Dashboard from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation from datadog_api_client.v1.model.formula_and_function_event_query_definition import ( FormulaAndFunctionEventQueryDefinition, ) from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import ( FormulaAndFunctionEventQueryDefinitionCompute, ) from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import ( FormulaAndFunctionEventQueryDefinitionSearch, ) from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource from datadog_api_client.v1.model.widget import Widget from datadog_api_client.v1.model.widget_histogram_request_type import WidgetHistogramRequestType from datadog_api_client.v1.model.widget_layout import WidgetLayout from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign body = Dashboard( title="Example-Dashboard", description="Example-Dashboard", widgets=[ Widget( definition=DistributionWidgetDefinition( title="Events Platform - Request latency HOP", title_size="16", title_align=WidgetTextAlign.LEFT, show_legend=False, type=DistributionWidgetDefinitionType.DISTRIBUTION, xaxis=DistributionWidgetXAxis( max="auto", include_zero=True, scale="linear", min="auto", ), yaxis=DistributionWidgetYAxis( max="auto", include_zero=True, scale="linear", min="auto", ), requests=[ DistributionWidgetRequest( query=FormulaAndFunctionEventQueryDefinition( search=FormulaAndFunctionEventQueryDefinitionSearch( query="", ), data_source=FormulaAndFunctionEventsDataSource.EVENTS, compute=FormulaAndFunctionEventQueryDefinitionCompute( metric="@duration", aggregation=FormulaAndFunctionEventAggregation.MIN, ), name="query1", indexes=[ "*", ], group_by=[], ), request_type=WidgetHistogramRequestType.HISTOGRAM, ), ], ), layout=WidgetLayout( x=0, y=0, width=4, height=2, ), ), ], layout_type=DashboardLayoutType.ORDERED, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.create_dashboard(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) # Create a dashboard. title = 'Average Memory Free Shell' widgets = [{ 'definition': { 'type' => 'timeseries', 'requests' => [ {'q' => 'avg:system.mem.free{*}'} ], 'title' => 'Average Memory Free' } }] layout_type = 'ordered' description = 'A dashboard with memory info.' is_read_only = true notify_list = ['user@domain.com'] template_variables = [{ 'name' => 'host', 'prefix' => 'host', 'default' => '' }] saved_view = [{ 'name': 'Saved views for hostname 2', 'template_variables': [{'name': 'host', 'value': ''}]} ] dog.create_board(title, widgets, layout_type, { :description => description, :is_read_only => is_read_only, :notify_list => notify_list, :template_variables => template_variables, :template_variable_presets => saved_view }) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```ruby # Clients deserialize a dashboard with a empty time object require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new body = DatadogAPIClient::V1::Dashboard.new({ title: "Example-Dashboard", widgets: [ DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::TimeseriesWidgetDefinition.new({ title: "Example Cloud Cost Query", title_size: "16", title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, type: DatadogAPIClient::V1::TimeseriesWidgetDefinitionType::TIMESERIES, requests: [ DatadogAPIClient::V1::TimeseriesWidgetRequest.new({ formulas: [ DatadogAPIClient::V1::WidgetFormula.new({ formula: "query1", }), ], queries: [ DatadogAPIClient::V1::FormulaAndFunctionCloudCostQueryDefinition.new({ data_source: DatadogAPIClient::V1::FormulaAndFunctionCloudCostDataSource::CLOUD_COST, name: "query1", query: "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)", }), ], response_format: DatadogAPIClient::V1::FormulaAndFunctionResponseFormat::TIMESERIES, style: DatadogAPIClient::V1::WidgetRequestStyle.new({ palette: "dog_classic", line_type: DatadogAPIClient::V1::WidgetLineType::SOLID, line_width: DatadogAPIClient::V1::WidgetLineWidth::NORMAL, }), display_type: DatadogAPIClient::V1::WidgetDisplayType::BARS, }), ], time: DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}), }), }), ], layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, }) p api_instance.create_dashboard(body) ``` ##### ```ruby # Create a distribution widget using a histogram request containing a formulas and functions APM Stats query require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new body = DatadogAPIClient::V1::Dashboard.new({ title: "Example-Dashboard", description: "", widgets: [ DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({ title: "APM Stats - Request latency HOP", title_size: "16", title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, show_legend: false, type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION, xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({ max: "auto", include_zero: true, scale: "linear", min: "auto", }), yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({ max: "auto", include_zero: true, scale: "linear", min: "auto", }), requests: [ DatadogAPIClient::V1::DistributionWidgetRequest.new({ query: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefinition.new({ primary_tag_value: "*", stat: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION, data_source: DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource::APM_RESOURCE_STATS, name: "query1", service: "azure-bill-import", group_by: [ "resource_name", ], env: "staging", primary_tag_name: "datacenter", operation_name: "universal.http.client", }), request_type: DatadogAPIClient::V1::WidgetHistogramRequestType::HISTOGRAM, style: DatadogAPIClient::V1::WidgetStyle.new({ palette: "dog_classic", }), }), ], }), layout: DatadogAPIClient::V1::WidgetLayout.new({ x: 8, y: 0, width: 4, height: 2, }), }), ], layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, }) p api_instance.create_dashboard(body) ``` ##### ```ruby # Create a distribution widget using a histogram request containing a formulas and functions events query require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new body = DatadogAPIClient::V1::Dashboard.new({ title: "Example-Dashboard", description: "Example-Dashboard", widgets: [ DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({ title: "Events Platform - Request latency HOP", title_size: "16", title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT, show_legend: false, type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION, xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({ max: "auto", include_zero: true, scale: "linear", min: "auto", }), yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({ max: "auto", include_zero: true, scale: "linear", min: "auto", }), requests: [ DatadogAPIClient::V1::DistributionWidgetRequest.new({ query: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition.new({ search: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch.new({ query: "", }), data_source: DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource::EVENTS, compute: DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute.new({ metric: "@duration", aggregation: DatadogAPIClient::V1::FormulaAndFunctionEventAggregation::MIN, }), name: "query1", indexes: [ "*", ], group_by: [], }), request_type: DatadogAPIClient::V1::WidgetHistogramRequestType::HISTOGRAM, }), ], }), layout: DatadogAPIClient::V1::WidgetLayout.new({ x: 0, y: 0, width: 4, height: 2, }), }), ], layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, }) p api_instance.create_dashboard(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Clients deserialize a dashboard with a empty time object use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::Dashboard; use datadog_api_client::datadogV1::model::DashboardLayoutType; use datadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostDataSource; use datadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostQueryDefinition; use datadog_api_client::datadogV1::model::FormulaAndFunctionQueryDefinition; use datadog_api_client::datadogV1::model::FormulaAndFunctionResponseFormat; use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinition; use datadog_api_client::datadogV1::model::TimeseriesWidgetDefinitionType; use datadog_api_client::datadogV1::model::TimeseriesWidgetRequest; use datadog_api_client::datadogV1::model::Widget; use datadog_api_client::datadogV1::model::WidgetDefinition; use datadog_api_client::datadogV1::model::WidgetDisplayType; use datadog_api_client::datadogV1::model::WidgetFormula; use datadog_api_client::datadogV1::model::WidgetLegacyLiveSpan; use datadog_api_client::datadogV1::model::WidgetLineType; use datadog_api_client::datadogV1::model::WidgetLineWidth; use datadog_api_client::datadogV1::model::WidgetRequestStyle; use datadog_api_client::datadogV1::model::WidgetTextAlign; use datadog_api_client::datadogV1::model::WidgetTime; #[tokio::main] async fn main() { let body = Dashboard::new( DashboardLayoutType::ORDERED, "Example-Dashboard".to_string(), vec![ Widget::new( WidgetDefinition::TimeseriesWidgetDefinition( Box::new( TimeseriesWidgetDefinition::new( vec![ TimeseriesWidgetRequest::new() .display_type(WidgetDisplayType::BARS) .formulas(vec![WidgetFormula::new("query1".to_string())]) .queries( vec![ FormulaAndFunctionQueryDefinition ::FormulaAndFunctionCloudCostQueryDefinition( Box::new( FormulaAndFunctionCloudCostQueryDefinition::new( FormulaAndFunctionCloudCostDataSource::CLOUD_COST, "query1".to_string(), "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)".to_string(), ), ), ) ], ) .response_format(FormulaAndFunctionResponseFormat::TIMESERIES) .style( WidgetRequestStyle::new() .line_type(WidgetLineType::SOLID) .line_width(WidgetLineWidth::NORMAL) .palette("dog_classic".to_string()), ) ], TimeseriesWidgetDefinitionType::TIMESERIES, ) .time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new()))) .title("Example Cloud Cost Query".to_string()) .title_align(WidgetTextAlign::LEFT) .title_size("16".to_string()), ), ), ) ], ); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.create_dashboard(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Create a distribution widget using a histogram request containing a formulas // and functions APM Stats query use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::Dashboard; use datadog_api_client::datadogV1::model::DashboardLayoutType; use datadog_api_client::datadogV1::model::DistributionWidgetDefinition; use datadog_api_client::datadogV1::model::DistributionWidgetDefinitionType; use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery; use datadog_api_client::datadogV1::model::DistributionWidgetRequest; use datadog_api_client::datadogV1::model::DistributionWidgetXAxis; use datadog_api_client::datadogV1::model::DistributionWidgetYAxis; use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatName; use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsDataSource; use datadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsQueryDefinition; use datadog_api_client::datadogV1::model::Widget; use datadog_api_client::datadogV1::model::WidgetDefinition; use datadog_api_client::datadogV1::model::WidgetHistogramRequestType; use datadog_api_client::datadogV1::model::WidgetLayout; use datadog_api_client::datadogV1::model::WidgetStyle; use datadog_api_client::datadogV1::model::WidgetTextAlign; #[tokio::main] async fn main() { let body = Dashboard::new( DashboardLayoutType::ORDERED, "Example-Dashboard".to_string(), vec![ Widget::new( WidgetDefinition::DistributionWidgetDefinition( Box::new( DistributionWidgetDefinition::new( vec![ DistributionWidgetRequest::new() .query( DistributionWidgetHistogramRequestQuery ::FormulaAndFunctionApmResourceStatsQueryDefinition( Box::new( FormulaAndFunctionApmResourceStatsQueryDefinition::new( FormulaAndFunctionApmResourceStatsDataSource ::APM_RESOURCE_STATS, "staging".to_string(), "query1".to_string(), "azure-bill-import".to_string(), FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION, ) .group_by(vec!["resource_name".to_string()]) .operation_name("universal.http.client".to_string()) .primary_tag_name("datacenter".to_string()) .primary_tag_value("*".to_string()), ), ), ) .request_type(WidgetHistogramRequestType::HISTOGRAM) .style(WidgetStyle::new().palette("dog_classic".to_string())) ], DistributionWidgetDefinitionType::DISTRIBUTION, ) .show_legend(false) .title("APM Stats - Request latency HOP".to_string()) .title_align(WidgetTextAlign::LEFT) .title_size("16".to_string()) .xaxis( DistributionWidgetXAxis::new() .include_zero(true) .max("auto".to_string()) .min("auto".to_string()) .scale("linear".to_string()), ) .yaxis( DistributionWidgetYAxis::new() .include_zero(true) .max("auto".to_string()) .min("auto".to_string()) .scale("linear".to_string()), ), ), ), ).layout(WidgetLayout::new(2, 4, 8, 0)) ], ).description(Some("".to_string())); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.create_dashboard(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Create a distribution widget using a histogram request containing a formulas // and functions events query use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::Dashboard; use datadog_api_client::datadogV1::model::DashboardLayoutType; use datadog_api_client::datadogV1::model::DistributionWidgetDefinition; use datadog_api_client::datadogV1::model::DistributionWidgetDefinitionType; use datadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery; use datadog_api_client::datadogV1::model::DistributionWidgetRequest; use datadog_api_client::datadogV1::model::DistributionWidgetXAxis; use datadog_api_client::datadogV1::model::DistributionWidgetYAxis; use datadog_api_client::datadogV1::model::FormulaAndFunctionEventAggregation; use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinition; use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionCompute; use datadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionSearch; use datadog_api_client::datadogV1::model::FormulaAndFunctionEventsDataSource; use datadog_api_client::datadogV1::model::Widget; use datadog_api_client::datadogV1::model::WidgetDefinition; use datadog_api_client::datadogV1::model::WidgetHistogramRequestType; use datadog_api_client::datadogV1::model::WidgetLayout; use datadog_api_client::datadogV1::model::WidgetTextAlign; #[tokio::main] async fn main() { let body = Dashboard::new( DashboardLayoutType::ORDERED, "Example-Dashboard".to_string(), vec![ Widget::new( WidgetDefinition::DistributionWidgetDefinition( Box::new( DistributionWidgetDefinition::new( vec![ DistributionWidgetRequest::new() .query( DistributionWidgetHistogramRequestQuery ::FormulaAndFunctionEventQueryDefinition( Box::new( FormulaAndFunctionEventQueryDefinition::new( FormulaAndFunctionEventQueryDefinitionCompute::new( FormulaAndFunctionEventAggregation::MIN, ).metric("@duration".to_string()), FormulaAndFunctionEventsDataSource::EVENTS, "query1".to_string(), ) .group_by(vec![]) .indexes(vec!["*".to_string()]) .search( FormulaAndFunctionEventQueryDefinitionSearch::new( "".to_string(), ), ), ), ), ) .request_type(WidgetHistogramRequestType::HISTOGRAM) ], DistributionWidgetDefinitionType::DISTRIBUTION, ) .show_legend(false) .title("Events Platform - Request latency HOP".to_string()) .title_align(WidgetTextAlign::LEFT) .title_size("16".to_string()) .xaxis( DistributionWidgetXAxis::new() .include_zero(true) .max("auto".to_string()) .min("auto".to_string()) .scale("linear".to_string()), ) .yaxis( DistributionWidgetYAxis::new() .include_zero(true) .max("auto".to_string()) .min("auto".to_string()) .scale("linear".to_string()), ), ), ), ).layout(WidgetLayout::new(2, 4, 0, 0)) ], ).description(Some("Example-Dashboard".to_string())); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.create_dashboard(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Clients deserialize a dashboard with a empty time object */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiCreateDashboardRequest = { body: { title: "Example-Dashboard", widgets: [ { definition: { title: "Example Cloud Cost Query", titleSize: "16", titleAlign: "left", type: "timeseries", requests: [ { formulas: [ { formula: "query1", }, ], queries: [ { dataSource: "cloud_cost", name: "query1", query: "sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)", }, ], responseFormat: "timeseries", style: { palette: "dog_classic", lineType: "solid", lineWidth: "normal", }, displayType: "bars", }, ], time: {}, }, }, ], layoutType: "ordered", }, }; apiInstance .createDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Create a distribution widget using a histogram request containing a formulas and functions APM Stats query */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiCreateDashboardRequest = { body: { title: "Example-Dashboard", description: "", widgets: [ { definition: { title: "APM Stats - Request latency HOP", titleSize: "16", titleAlign: "left", showLegend: false, type: "distribution", xaxis: { max: "auto", includeZero: true, scale: "linear", min: "auto", }, yaxis: { max: "auto", includeZero: true, scale: "linear", min: "auto", }, requests: [ { query: { primaryTagValue: "*", stat: "latency_distribution", dataSource: "apm_resource_stats", name: "query1", service: "azure-bill-import", groupBy: ["resource_name"], env: "staging", primaryTagName: "datacenter", operationName: "universal.http.client", }, requestType: "histogram", style: { palette: "dog_classic", }, }, ], }, layout: { x: 8, y: 0, width: 4, height: 2, }, }, ], layoutType: "ordered", }, }; apiInstance .createDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Create a distribution widget using a histogram request containing a formulas and functions events query */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiCreateDashboardRequest = { body: { title: "Example-Dashboard", description: "Example-Dashboard", widgets: [ { definition: { title: "Events Platform - Request latency HOP", titleSize: "16", titleAlign: "left", showLegend: false, type: "distribution", xaxis: { max: "auto", includeZero: true, scale: "linear", min: "auto", }, yaxis: { max: "auto", includeZero: true, scale: "linear", min: "auto", }, requests: [ { query: { search: { query: "", }, dataSource: "events", compute: { metric: "@duration", aggregation: "min", }, name: "query1", indexes: ["*"], groupBy: [], }, requestType: "histogram", }, ], }, layout: { x: 0, y: 0, width: 4, height: 2, }, }, ], layoutType: "ordered", }, }; apiInstance .createDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get a dashboard{% #get-a-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id} | ### Overview Get a dashboard using the specified ID. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | ------------------------ | | dashboard_id [*required*] | string | The ID of the dashboard. | ### Response {% tab title="200" %} OK {% tab title="Model" %} 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. | Parent field | Field | Type | Description | | ------------------------- | ------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | author_handle | string | Identifier of the dashboard author. | | | author_name | string | Name of the dashboard author. | | | created_at | date-time | Creation date of the dashboard. | | | description | string | Description of the dashboard. | | | id | string | ID of the dashboard. | | | is_read_only | boolean | **DEPRECATED**: 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 [*required*] | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | | modified_at | date-time | Modification date of the dashboard. | | | notify_list | [string] | List of handles of users to notify when changes are made to this dashboard. | | | reflow_type | enum | 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. Allowed enum values: `auto,fixed` | | | 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 | [object] | List of tabs for organizing dashboard widgets into groups. | | tabs | id [*required*] | uuid | UUID of the tab. | | tabs | name [*required*] | string | Name of the tab. | | tabs | widget_ids [*required*] | [integer] | 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] | List of team names representing ownership of a dashboard. | | | template_variable_presets | [object] | Array of template variables saved views. | | template_variable_presets | name | string | The name of the variable. | | template_variable_presets | template_variables | [object] | List of variables. | | template_variables | name | string | The name of the variable. | | template_variables | value | string | **DEPRECATED**: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. | | template_variables | 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 | [object] | List of template variables for this dashboard. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. | | template_variables | 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`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | template_variables | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | | title [*required*] | string | Title of the dashboard. | | | url | string | The URL of the dashboard. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). | | definition | Option 1 | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | Option 1 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 1 | description | string | The description of the widget. | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | The title of the widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph` | | Option 1 | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist` | | definition | Option 2 | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | Option 2 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 2 | description | string | The description of the widget. | | Option 2 | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | Option 2 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of value in the widget. | | Option 2 | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value` | | Option 2 | unit | string | Unit to display with the value. | | definition | Option 3 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 3 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 3 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | Title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | Size of the title. | | Option 3 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | definition | Option 4 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | description | string | The description of the widget. | | Option 4 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | title | string | Title of the widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | definition | Option 5 | object | Check status shows the current status or number of results for any check performed. | | Option 5 | check [*required*] | string | Name of the check to use in the widget. | | Option 5 | description | string | The description of the widget. | | Option 5 | group | string | Group reporting a single check. | | Option 5 | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | Option 5 | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check,cluster` | | Option 5 | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of the widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status` | | definition | Option 6 | object | 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. | | Option 6 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 6 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | requests | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | requests | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of the widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution` | | Option 6 | xaxis | object | X Axis controls for the distribution widget. | | xaxis | include_zero | boolean | True includes zero. | | xaxis | max | string | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | min | string | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | num_buckets | int64 | Number of value buckets to target, also known as the resolution of the value bins. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`. | | Option 6 | yaxis | object | Y Axis controls for the distribution widget. | | yaxis | include_zero | boolean | True includes zero. | | yaxis | label | string | The label of the axis to display on the graph. | | yaxis | max | string | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. | | definition | Option 7 | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | Option 7 | description | string | The description of the widget. | | Option 7 | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | Option 7 | query [*required*] | string | Query to filter the event stream with. | | Option 7 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of the widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream` | | definition | Option 8 | object | 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. | | Option 8 | description | string | The description of the widget. | | Option 8 | query [*required*] | string | Query to filter the event timeline with. | | Option 8 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of the widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline` | | definition | Option 9 | object | Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. | | Option 9 | 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`. | | Option 9 | color | string | Color of the text. | | Option 9 | font_size | string | Size of the text. | | Option 9 | text [*required*] | string | Text to display. | | Option 9 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text` | | definition | Option 10 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Option 10 | description | string | The description of the widget. | | Option 10 | requests [*required*] | [object] | Request payload used to query items. | | requests | query [*required*] | object | Updated funnel widget. | | query | data_source [*required*] | enum | Source from which to query items to display in the funnel. Allowed enum values: `rum` | | query | query_string [*required*] | string | The widget query. | | query | steps [*required*] | [object] | List of funnel steps. | | steps | facet [*required*] | string | The facet of the step. | | steps | value [*required*] | string | The value of the step. | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `funnel` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | The title of the widget. | | Option 10 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 10 | title_size | string | The size of the title. | | Option 10 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel` | | definition | Option 11 | object | This visualization displays a series of values by country on a world map. | | Option 11 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 11 | description | string | The description of the widget. | | Option 11 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 11 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 11 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 11 | title | string | The title of your widget. | | Option 11 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 11 | title_size | string | The size of the title. | | Option 11 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 11 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | definition | Option 12 | object | 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. | | Option 12 | 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`. | | Option 12 | banner_img | string | URL of image to display as a banner for the group. | | Option 12 | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered` | | Option 12 | show_title | boolean | Whether to show the title or not. | | Option 12 | title | string | Title of the widget. | | Option 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 12 | type [*required*] | enum | Type of the group widget. Allowed enum values: `group` | | Option 12 | widgets [*required*] | [object] | List of widget groups. | | definition | Option 13 | object | 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. | | Option 13 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 13 | description | string | The description of the widget. | | Option 13 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 13 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 13 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 13 | requests [*required*] | [object] | List of widget types. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | search [*required*] | string | The query being made on the event. | | event_query | tags_execution [*required*] | string | The execution method for multi-value filters. Can be either and or or. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | A formula and functions metrics query. | | query | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | query | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | query | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | query | name [*required*] | string | Name of the query for use in formulas. | | query | query [*required*] | string | Metrics query definition. | | query | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | requests | request_type | enum | Applicable only for distribution of point values for distribution metrics. Allowed enum values: `histogram` | | requests | response_format | enum | Applicable only for distribution of aggregated grouped queries. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 13 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 13 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 13 | title | string | Title of the widget. | | Option 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 13 | title_size | string | Size of the title. | | Option 13 | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap` | | Option 13 | xaxis | object | X Axis controls for the heat map widget. | | xaxis | num_buckets | int64 | 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). | | Option 13 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 14 | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | Option 14 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 14 | description | string | The description of the widget. | | Option 14 | group | [string] | List of tag prefixes to group by. | | Option 14 | no_group_hosts | boolean | Whether to show the hosts that don't fit in a group. | | Option 14 | no_metric_hosts | boolean | Whether to show the hosts with no metrics. | | Option 14 | node_type | enum | Which type of node to use in the map. Allowed enum values: `host,container` | | Option 14 | notes | string | Notes on the title. | | Option 14 | requests [*required*] | object | List of definitions. | | requests | fill | object | Updated host map. | | fill | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | fill | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | q | string | Query definition. | | fill | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | size | object | Updated host map. | | size | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | size | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | q | string | Query definition. | | size | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 14 | scope | [string] | List of tags used to filter the map. | | Option 14 | style | object | The style to apply to the widget. | | style | fill_max | string | Max value to use to color the map. | | style | fill_min | string | Min value to use to color the map. | | style | palette | string | Color palette to apply to the widget. | | style | palette_flip | boolean | Whether to flip the palette tones. | | Option 14 | title | string | Title of the widget. | | Option 14 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 14 | title_size | string | Size of the title. | | Option 14 | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap` | | definition | Option 15 | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | Option 15 | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe` | | Option 15 | url [*required*] | string | URL of the iframe. | | definition | Option 16 | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | Option 16 | has_background | boolean | Whether to display a background or not. | | Option 16 | has_border | boolean | Whether to display a border or not. | | Option 16 | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center,left,right` | | Option 16 | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large` | | Option 16 | sizing | enum | 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. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center` | | Option 16 | type [*required*] | enum | Type of the image widget. Allowed enum values: `image` | | Option 16 | url [*required*] | string | URL of the image. | | Option 16 | url_dark_theme | string | URL of the image in dark mode. | | Option 16 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 17 | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | Option 17 | description | string | The description of the widget. | | Option 17 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 17 | requests [*required*] | [object] | Request payload used to query items. | | requests | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | Option 17 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 17 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 17 | title | string | Title of the widget. | | Option 17 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 17 | title_size | string | Size of the title. | | Option 17 | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream` | | definition | Option 18 | object | The Log Stream displays a log flow matching the defined query. | | Option 18 | columns | [string] | Which columns to display on the widget. | | Option 18 | description | string | The description of the widget. | | Option 18 | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | Option 18 | logset | string | **DEPRECATED**: ID of the log set to use. | | Option 18 | message_display | enum | Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg` | | Option 18 | query | string | Query to filter the log stream with. | | Option 18 | show_date_column | boolean | Whether to show the date column or not | | Option 18 | show_message_column | boolean | Whether to show the message column or not | | Option 18 | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 18 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 18 | title | string | Title of the widget. | | Option 18 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 18 | title_size | string | Size of the title. | | Option 18 | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream` | | definition | Option 19 | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | Option 19 | color_preference | enum | Which color to use on the widget. Allowed enum values: `background,text` | | Option 19 | count | int64 | **DEPRECATED**: The number of monitors to display. | | Option 19 | description | string | The description of the widget. | | Option 19 | display_format | enum | What to display on the widget. Allowed enum values: `counts,countsAndList,list` | | Option 19 | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | Option 19 | query [*required*] | string | Query to filter the monitors with. | | Option 19 | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | Option 19 | show_priority | boolean | Whether to show the priorities column. | | Option 19 | sort | enum | Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc` | | Option 19 | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | Option 19 | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors,groups,combined` | | Option 19 | title | string | Title of the widget. | | Option 19 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 19 | title_size | string | Size of the title. | | Option 19 | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status` | | definition | Option 20 | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | Option 20 | background_color | string | Background color of the note. | | Option 20 | content [*required*] | string | Content of the note. | | Option 20 | font_size | string | Size of the text. | | Option 20 | has_padding | boolean | Whether to add padding or not. | | Option 20 | show_tick | boolean | Whether to show a tick or not. | | Option 20 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 20 | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top` | | Option 20 | tick_pos | string | Where to position the tick on an edge. | | Option 20 | type [*required*] | enum | Type of the note widget. Allowed enum values: `note` | | Option 20 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 21 | object | 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. | | Option 21 | background_color | string | Background color of the powerpack title. | | Option 21 | banner_img | string | URL of image to display as a banner for the powerpack. | | Option 21 | powerpack_id [*required*] | string | UUID of the associated powerpack. | | Option 21 | show_title | boolean | Whether to show the title or not. | | Option 21 | template_variables | object | Powerpack template variables. | | template_variables | controlled_by_powerpack | [object] | Template variables controlled at the powerpack level. | | controlled_by_powerpack | name [*required*] | string | The name of the variable. | | controlled_by_powerpack | prefix | string | The tag prefix associated with the variable. | | controlled_by_powerpack | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | template_variables | controlled_externally | [object] | Template variables controlled by the external resource, such as the dashboard this powerpack is on. | | controlled_externally | name [*required*] | string | The name of the variable. | | controlled_externally | prefix | string | The tag prefix associated with the variable. | | controlled_externally | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | Option 21 | title | string | Title of the widget. | | Option 21 | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack` | | definition | Option 22 | object | Query values display the current value of a given metric, APM, or log query. | | Option 22 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 22 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 22 | custom_unit | string | Display a unit of your choice on the widget. | | Option 22 | description | string | The description of the widget. | | Option 22 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 22 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 22 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 22 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 22 | title | string | Title of your widget. | | Option 22 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | title_size | string | Size of the title. | | Option 22 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | definition | Option 23 | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | Option 23 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 23 | description | string | The description of the widget. | | Option 23 | inputs | [object] | Array of workflow inputs to map to dashboard template variables. | | inputs | name [*required*] | string | Name of the workflow input. | | inputs | value [*required*] | string | Dashboard template variable. Can be suffixed with '.value' or '.key'. | | Option 23 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 23 | title | string | Title of your widget. | | Option 23 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 23 | title_size | string | Size of the title. | | Option 23 | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow` | | Option 23 | workflow_id [*required*] | string | Workflow id. | | definition | Option 24 | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | Option 24 | description | string | The description of the widget. | | Option 24 | requests [*required*] | [object] | Array of one request object to display in the widget. | | requests | query [*required*] | object | Updated SLO List widget. | | query | limit | int64 | Maximum number of results to display in the table. | | query | query_string [*required*] | string | Widget query. | | query | sort | [object] | Options for sorting results. | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `slo_list` | | Option 24 | title | string | Title of the widget. | | Option 24 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 24 | title_size | string | Size of the title. | | Option 24 | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list` | | definition | Option 25 | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | Option 25 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 25 | description | string | The description of the widget. | | Option 25 | global_time_target | string | Defined global time target. | | Option 25 | show_error_budget | boolean | Defined error budget. | | Option 25 | slo_id | string | ID of the SLO displayed. | | Option 25 | time_windows | [string] | Times being monitored. | | Option 25 | title | string | Title of the widget. | | Option 25 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 25 | title_size | string | Size of the title. | | Option 25 | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo` | | Option 25 | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both` | | Option 25 | view_type [*required*] | string | Type of view displayed by the widget. | | definition | Option 26 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 26 | color_by_groups | [string] | List of groups used for colors. | | Option 26 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 26 | description | string | The description of the widget. | | Option 26 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 26 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 26 | title | string | Title of your widget. | | Option 26 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 26 | title_size | string | Size of the title. | | Option 26 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 26 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 26 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 27 | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | Option 27 | requests [*required*] | [ ] | List of Sankey widget requests. | | requests | Option 1 | object | Sankey widget with RUM data source. | | Option 1 | query [*required*] | object | Sankey widget with RUM data source query. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | accounts | name | string | | accounts | query | string | | audience_filters | filter_condition | string | | audience_filters | segments | [object] | | segments | name | string | | segments | segment_id | string | | audience_filters | users | [object] | | users | name | string | | users | query | string | | query | data_source [*required*] | enum | Sankey widget with RUM data source. Allowed enum values: `rum,product_analytics` | | query | entries_per_step | int64 | Entries per step. | | query | join_keys | object | Join keys. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | query | mode [*required*] | enum | Sankey mode for RUM queries. Allowed enum values: `source,target` | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | | occurrences | operator | string | | occurrences | value | string | | query | query_string [*required*] | string | Query string. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | Option 1 | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | requests | Option 2 | object | Sankey widget request for network data source. | | Option 2 | query [*required*] | object | Query configuration for Sankey network widget. | | query | compute | object | Compute aggregation for network queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Option 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent` | | aggregation | Option 2 | string | Percentile aggregation. | | compute | metric [*required*] | string | Metric to aggregate. | | query | data_source [*required*] | enum | Network data source type. Allowed enum values: `network_device_flows,network` | | query | group_by [*required*] | [string] | Fields to group by. | | query | limit [*required*] | int64 | Maximum number of results. | | query | mode | enum | Sankey mode for network queries. Allowed enum values: `target` | | query | query_string [*required*] | string | Query string for filtering network data. | | query | should_exclude_missing | boolean | Whether to exclude missing values. | | query | sort | object | Sort configuration for network queries. | | sort | field | string | Field to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey` | | Option 27 | show_other_links | boolean | Whether to show links for "other" category. | | Option 27 | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | Option 27 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 27 | title | string | Title of your widget. | | Option 27 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 27 | title_size | string | Size of the title. | | Option 27 | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | definition | Option 28 | object | This widget displays a map of a service to all of the services that call it, and all of the services that it calls. | | Option 28 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 28 | description | string | The description of the widget. | | Option 28 | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | Option 28 | service [*required*] | string | The ID of the service you want to map. | | Option 28 | title | string | The title of your widget. | | Option 28 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 28 | title_size | string | Size of the title. | | Option 28 | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap` | | definition | Option 29 | object | The service summary displays the graphs of a chosen service in your dashboard. | | Option 29 | description | string | The description of the widget. | | Option 29 | display_format | enum | Number of columns to display. Allowed enum values: `one_column,two_column,three_column` | | Option 29 | env [*required*] | string | APM environment. | | Option 29 | service [*required*] | string | APM service. | | Option 29 | show_breakdown | boolean | Whether to show the latency breakdown or not. | | Option 29 | show_distribution | boolean | Whether to show the latency distribution or not. | | Option 29 | show_errors | boolean | Whether to show the error metrics or not. | | Option 29 | show_hits | boolean | Whether to show the hits metrics or not. | | Option 29 | show_latency | boolean | Whether to show the latency metrics or not. | | Option 29 | show_resource_list | boolean | Whether to show the resource list or not. | | Option 29 | size_format | enum | Size of the widget. Allowed enum values: `small,medium,large` | | Option 29 | span_name [*required*] | string | APM span name. | | Option 29 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 29 | title | string | Title of the widget. | | Option 29 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 29 | title_size | string | Size of the title. | | Option 29 | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service` | | definition | Option 30 | object | The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) | | Option 30 | has_uniform_y_axes | boolean | Normalize y axes across graphs | | Option 30 | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg` | | Option 30 | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | Option 1 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 1 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 1 | description | string | The description of the widget. | | Option 1 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 1 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | Title of your widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | source_widget_definition | Option 2 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 2 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 2 | description | string | The description of the widget. | | Option 2 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 2 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of the title. | | Option 2 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | source_widget_definition | Option 3 | object | This visualization displays a series of values by country on a world map. | | Option 3 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 3 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | The title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | The size of the title. | | Option 3 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 3 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | source_widget_definition | Option 4 | object | Query values display the current value of a given metric, APM, or log query. | | Option 4 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | custom_unit | string | Display a unit of your choice on the widget. | | Option 4 | description | string | The description of the widget. | | Option 4 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 4 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 4 | title | string | Title of your widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | source_widget_definition | Option 5 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 5 | color_by_groups | [string] | List of groups used for colors. | | Option 5 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 5 | description | string | The description of the widget. | | Option 5 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of your widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 5 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 5 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 6 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 6 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | hide_total | boolean | Show the total value in this widget. | | Option 6 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 6 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of your widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | source_widget_definition | Option 7 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 7 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 7 | description | string | The description of the widget. | | Option 7 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 7 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of your widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | source_widget_definition | Option 8 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 8 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 8 | description | string | The description of the widget. | | Option 8 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 8 | legend_columns | [string] | Columns displayed in the legend. | | Option 8 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 8 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 8 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 8 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 8 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 8 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of your widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 8 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 9 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 9 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 9 | description | string | The description of the widget. | | Option 9 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 9 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 9 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 9 | title | string | Title of your widget. | | Option 9 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | title_size | string | Size of the title. | | Option 9 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | source_widget_definition | Option 10 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 10 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 10 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 10 | description | string | The description of the widget. | | Option 10 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 10 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 10 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | Title of your widget. | | Option 10 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | Option 30 | split_config [*required*] | object | Encapsulates all user choices about how to split a graph. | | split_config | limit [*required*] | int64 | Maximum number of graphs to display in the widget. | | split_config | sort [*required*] | object | Controls the order in which graphs appear in the split. | | sort | compute | object | Defines the metric and aggregation used as the sort value. | | compute | aggregation [*required*] | string | How to aggregate the sort metric for the purposes of ordering. | | compute | metric [*required*] | string | The metric to use for sorting graphs. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | split_config | split_dimensions [*required*] | [object] | The dimension(s) on which to split the graph | | split_dimensions | one_graph_per [*required*] | string | The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. | | split_config | static_splits | [array] | Manual selection of tags making split graph widget static | | Option 30 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 30 | title | string | Title of your widget. | | Option 30 | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group` | | definition | Option 31 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 31 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 31 | description | string | The description of the widget. | | Option 31 | hide_total | boolean | Show the total value in this widget. | | Option 31 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 31 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 31 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 31 | title | string | Title of your widget. | | Option 31 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 31 | title_size | string | Size of the title. | | Option 31 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | definition | Option 32 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 32 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 32 | description | string | The description of the widget. | | Option 32 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 32 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 32 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 32 | title | string | Title of your widget. | | Option 32 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 32 | title_size | string | Size of the title. | | Option 32 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | definition | Option 33 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 33 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 33 | description | string | The description of the widget. | | Option 33 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 33 | legend_columns | [string] | Columns displayed in the legend. | | Option 33 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 33 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 33 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 33 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 33 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 33 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 33 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 33 | title | string | Title of your widget. | | Option 33 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 33 | title_size | string | Size of the title. | | Option 33 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 33 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 34 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 34 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 34 | description | string | The description of the widget. | | Option 34 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 34 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 34 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 34 | title | string | Title of your widget. | | Option 34 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 34 | title_size | string | Size of the title. | | Option 34 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | definition | Option 35 | object | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Option 35 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 35 | description | string | The description of the widget. | | Option 35 | requests [*required*] | [object] | One or more Topology requests. | | requests | query | object | Query to service-based topology data sources like the service map or data streams. | | query | data_source | enum | Name of the data source Allowed enum values: `data_streams,service_map` | | query | filters | [string] | Your environment and primary tag (or * if enabled for your account). | | query | service | string | Name of the service | | requests | request_type | enum | Widget request type. Allowed enum values: `topology` | | Option 35 | title | string | Title of your widget. | | Option 35 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 35 | title_size | string | Size of the title. | | Option 35 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map` | | definition | Option 36 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 36 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 36 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 36 | description | string | The description of the widget. | | Option 36 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 36 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 36 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 36 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 36 | title | string | Title of your widget. | | Option 36 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | definition | Option 37 | object | Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. | | Option 37 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 37 | requests [*required*] | [ ] | List of data requests for the wildcard widget. | | requests | Option 1 | object | An updated treemap widget. | | Option 1 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Option 1 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 1 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | Option 2 | object | Updated timeseries widget. | | Option 2 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | Option 2 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 2 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Option 2 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Option 2 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 2 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 2 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 2 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 2 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | requests | Option 3 | object | Updated list stream widget. | | Option 3 | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | Option 3 | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | Option 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | requests | Option 4 | object | Updated distribution widget. | | Option 4 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | Option 4 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 4 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 4 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 4 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 4 | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | Option 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | Option 4 | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | Option 4 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 37 | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See [https://vega.github.io/vega-lite/](https://vega.github.io/vega-lite/) for the full grammar reference. | | specification | contents [*required*] | object | The Vega or Vega-Lite JSON specification object. | | specification | type [*required*] | enum | Type of specification used by the wildcard widget. Allowed enum values: `vega,vega-lite` | | Option 37 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 37 | title | string | Title of the widget. | | Option 37 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 37 | title_size | string | Size of the title. | | Option 37 | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard` | | widgets | id | int64 | ID of the widget. | | widgets | layout | object | The layout for a widget on a `free` or **new dashboard layout** dashboard. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | is_column_break | boolean | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | {% /tab %} {% tab title="Example" %} ```json { "author_handle": "test@datadoghq.com", "author_name": "John Doe", "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "id": "123-abc-456", "is_read_only": false, "layout_type": "ordered", "modified_at": "2019-09-19T10:00:00.000Z", "notify_list": [], "reflow_type": "string", "restricted_roles": [], "tabs": [ { "id": "", "name": "L", "widget_ids": [ 0 ] } ], "tags": [], "template_variable_presets": [ { "name": "string", "template_variables": [ { "name": "string", "value": "string", "values": [] } ] } ], "template_variables": [ { "available_values": [ "my-host", "host1", "host2" ], "default": "my-host", "defaults": [ "my-host-1", "my-host-2" ], "name": "host1", "prefix": "host", "type": "group" } ], "title": "", "url": "/dashboard/123-abc-456/example-dashboard-title", "widgets": [ { "definition": { "requests": { "fill": { "q": "avg:system.cpu.user{*}" } }, "type": "hostmap" }, "id": "integer", "layout": { "height": 0, "is_column_break": false, "width": 0, "x": 0, "y": 0 } } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Item Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport dashboard_id="CHANGE_ME"\# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.get_dashboard( dashboard_id=DASHBOARD_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] p api_instance.get_dashboard(DASHBOARD_ID) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) dashboard_id = '' dog.get_board(dashboard_id) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.GetDashboard(ctx, DashboardID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); try { Dashboard result = apiInstance.getDashboard(DASHBOARD_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#getDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) dashboard_id = '' api.Dashboard.get(dashboard_id) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ##### ```rust // Get a dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.get_dashboard(dashboard_id.clone()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiGetDashboardRequest = { dashboardId: DASHBOARD_ID, }; apiInstance .getDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get all dashboards{% #get-all-dashboards %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/dashboard | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/dashboard | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/dashboard | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/dashboard | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/dashboard | ### Overview Get all dashboards. **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | filter[shared] | boolean | When `true`, this query only returns shared custom created or cloned dashboards. | | filter[deleted] | boolean | When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`. | | count | integer | The maximum number of dashboards returned in the list. | | start | integer | The specific offset to use as the beginning of the returned response. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Dashboard summary response. | Parent field | Field | Type | Description | | ------------ | ------------- | --------- | ---------------------------------------------------------------------------------------------------------------- | | | dashboards | [object] | List of dashboard definitions. | | dashboards | author_handle | string | Identifier of the dashboard author. | | dashboards | created_at | date-time | Creation date of the dashboard. | | dashboards | description | string | Description of the dashboard. | | dashboards | id | string | Dashboard identifier. | | dashboards | is_read_only | boolean | **DEPRECATED**: 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. | | dashboards | layout_type | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | dashboards | modified_at | date-time | Modification date of the dashboard. | | dashboards | title | string | Title of the dashboard. | | dashboards | url | string | URL of the dashboard. | {% /tab %} {% tab title="Example" %} ```json { "dashboards": [ { "author_handle": "string", "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "id": "string", "is_read_only": false, "layout_type": "ordered", "modified_at": "2019-09-19T10:00:00.000Z", "title": "string", "url": "string" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all dashboards returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.list_dashboards( filter_shared=False, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get all dashboards returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new opts = { filter_shared: false, } p api_instance.list_dashboards(opts) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) dog.get_all_boards() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get all dashboards returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.ListDashboards(ctx, *datadogV1.NewListDashboardsOptionalParameters().WithFilterShared(false)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.ListDashboards`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.ListDashboards`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get all dashboards returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters; import com.datadog.api.client.v1.model.DashboardSummary; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); try { DashboardSummary result = apiInstance.listDashboards(new ListDashboardsOptionalParameters().filterShared(false)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#listDashboards"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) api.Dashboard.get_all() ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ##### ```rust // Get all dashboards returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::api_dashboards::ListDashboardsOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .list_dashboards(ListDashboardsOptionalParams::default().filter_shared(false)) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get all dashboards returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiListDashboardsRequest = { filterShared: false, }; apiInstance .listDashboards(params) .then((data: v1.DashboardSummary) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Update a dashboard{% #update-a-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id} | ### Overview Update a dashboard using the specified ID. This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | ------------------------ | | dashboard_id [*required*] | string | The ID of the dashboard. | ### Request #### Body Data (required) Update Dashboard request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------------- | ------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | author_handle | string | Identifier of the dashboard author. | | | author_name | string | Name of the dashboard author. | | | created_at | date-time | Creation date of the dashboard. | | | description | string | Description of the dashboard. | | | id | string | ID of the dashboard. | | | is_read_only | boolean | **DEPRECATED**: 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 [*required*] | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | | modified_at | date-time | Modification date of the dashboard. | | | notify_list | [string] | List of handles of users to notify when changes are made to this dashboard. | | | reflow_type | enum | 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. Allowed enum values: `auto,fixed` | | | 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 | [object] | List of tabs for organizing dashboard widgets into groups. | | tabs | id [*required*] | uuid | UUID of the tab. | | tabs | name [*required*] | string | Name of the tab. | | tabs | widget_ids [*required*] | [integer] | 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] | List of team names representing ownership of a dashboard. | | | template_variable_presets | [object] | Array of template variables saved views. | | template_variable_presets | name | string | The name of the variable. | | template_variable_presets | template_variables | [object] | List of variables. | | template_variables | name | string | The name of the variable. | | template_variables | value | string | **DEPRECATED**: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. | | template_variables | 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 | [object] | List of template variables for this dashboard. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. | | template_variables | 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`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | template_variables | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | | title [*required*] | string | Title of the dashboard. | | | url | string | The URL of the dashboard. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). | | definition | Option 1 | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | Option 1 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 1 | description | string | The description of the widget. | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | The title of the widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph` | | Option 1 | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist` | | definition | Option 2 | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | Option 2 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 2 | description | string | The description of the widget. | | Option 2 | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | Option 2 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of value in the widget. | | Option 2 | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value` | | Option 2 | unit | string | Unit to display with the value. | | definition | Option 3 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 3 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 3 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | Title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | Size of the title. | | Option 3 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | definition | Option 4 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | description | string | The description of the widget. | | Option 4 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | title | string | Title of the widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | definition | Option 5 | object | Check status shows the current status or number of results for any check performed. | | Option 5 | check [*required*] | string | Name of the check to use in the widget. | | Option 5 | description | string | The description of the widget. | | Option 5 | group | string | Group reporting a single check. | | Option 5 | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | Option 5 | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check,cluster` | | Option 5 | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of the widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status` | | definition | Option 6 | object | 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. | | Option 6 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 6 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | requests | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | requests | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of the widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution` | | Option 6 | xaxis | object | X Axis controls for the distribution widget. | | xaxis | include_zero | boolean | True includes zero. | | xaxis | max | string | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | min | string | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | num_buckets | int64 | Number of value buckets to target, also known as the resolution of the value bins. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`. | | Option 6 | yaxis | object | Y Axis controls for the distribution widget. | | yaxis | include_zero | boolean | True includes zero. | | yaxis | label | string | The label of the axis to display on the graph. | | yaxis | max | string | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. | | definition | Option 7 | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | Option 7 | description | string | The description of the widget. | | Option 7 | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | Option 7 | query [*required*] | string | Query to filter the event stream with. | | Option 7 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of the widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream` | | definition | Option 8 | object | 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. | | Option 8 | description | string | The description of the widget. | | Option 8 | query [*required*] | string | Query to filter the event timeline with. | | Option 8 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of the widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline` | | definition | Option 9 | object | Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. | | Option 9 | 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`. | | Option 9 | color | string | Color of the text. | | Option 9 | font_size | string | Size of the text. | | Option 9 | text [*required*] | string | Text to display. | | Option 9 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text` | | definition | Option 10 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Option 10 | description | string | The description of the widget. | | Option 10 | requests [*required*] | [object] | Request payload used to query items. | | requests | query [*required*] | object | Updated funnel widget. | | query | data_source [*required*] | enum | Source from which to query items to display in the funnel. Allowed enum values: `rum` | | query | query_string [*required*] | string | The widget query. | | query | steps [*required*] | [object] | List of funnel steps. | | steps | facet [*required*] | string | The facet of the step. | | steps | value [*required*] | string | The value of the step. | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `funnel` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | The title of the widget. | | Option 10 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 10 | title_size | string | The size of the title. | | Option 10 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel` | | definition | Option 11 | object | This visualization displays a series of values by country on a world map. | | Option 11 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 11 | description | string | The description of the widget. | | Option 11 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 11 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 11 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 11 | title | string | The title of your widget. | | Option 11 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 11 | title_size | string | The size of the title. | | Option 11 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 11 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | definition | Option 12 | object | 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. | | Option 12 | 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`. | | Option 12 | banner_img | string | URL of image to display as a banner for the group. | | Option 12 | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered` | | Option 12 | show_title | boolean | Whether to show the title or not. | | Option 12 | title | string | Title of the widget. | | Option 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 12 | type [*required*] | enum | Type of the group widget. Allowed enum values: `group` | | Option 12 | widgets [*required*] | [object] | List of widget groups. | | definition | Option 13 | object | 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. | | Option 13 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 13 | description | string | The description of the widget. | | Option 13 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 13 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 13 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 13 | requests [*required*] | [object] | List of widget types. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | search [*required*] | string | The query being made on the event. | | event_query | tags_execution [*required*] | string | The execution method for multi-value filters. Can be either and or or. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | A formula and functions metrics query. | | query | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | query | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | query | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | query | name [*required*] | string | Name of the query for use in formulas. | | query | query [*required*] | string | Metrics query definition. | | query | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | requests | request_type | enum | Applicable only for distribution of point values for distribution metrics. Allowed enum values: `histogram` | | requests | response_format | enum | Applicable only for distribution of aggregated grouped queries. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 13 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 13 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 13 | title | string | Title of the widget. | | Option 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 13 | title_size | string | Size of the title. | | Option 13 | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap` | | Option 13 | xaxis | object | X Axis controls for the heat map widget. | | xaxis | num_buckets | int64 | 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). | | Option 13 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 14 | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | Option 14 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 14 | description | string | The description of the widget. | | Option 14 | group | [string] | List of tag prefixes to group by. | | Option 14 | no_group_hosts | boolean | Whether to show the hosts that don't fit in a group. | | Option 14 | no_metric_hosts | boolean | Whether to show the hosts with no metrics. | | Option 14 | node_type | enum | Which type of node to use in the map. Allowed enum values: `host,container` | | Option 14 | notes | string | Notes on the title. | | Option 14 | requests [*required*] | object | List of definitions. | | requests | fill | object | Updated host map. | | fill | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | fill | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | q | string | Query definition. | | fill | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | size | object | Updated host map. | | size | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | size | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | q | string | Query definition. | | size | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 14 | scope | [string] | List of tags used to filter the map. | | Option 14 | style | object | The style to apply to the widget. | | style | fill_max | string | Max value to use to color the map. | | style | fill_min | string | Min value to use to color the map. | | style | palette | string | Color palette to apply to the widget. | | style | palette_flip | boolean | Whether to flip the palette tones. | | Option 14 | title | string | Title of the widget. | | Option 14 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 14 | title_size | string | Size of the title. | | Option 14 | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap` | | definition | Option 15 | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | Option 15 | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe` | | Option 15 | url [*required*] | string | URL of the iframe. | | definition | Option 16 | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | Option 16 | has_background | boolean | Whether to display a background or not. | | Option 16 | has_border | boolean | Whether to display a border or not. | | Option 16 | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center,left,right` | | Option 16 | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large` | | Option 16 | sizing | enum | 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. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center` | | Option 16 | type [*required*] | enum | Type of the image widget. Allowed enum values: `image` | | Option 16 | url [*required*] | string | URL of the image. | | Option 16 | url_dark_theme | string | URL of the image in dark mode. | | Option 16 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 17 | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | Option 17 | description | string | The description of the widget. | | Option 17 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 17 | requests [*required*] | [object] | Request payload used to query items. | | requests | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | Option 17 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 17 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 17 | title | string | Title of the widget. | | Option 17 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 17 | title_size | string | Size of the title. | | Option 17 | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream` | | definition | Option 18 | object | The Log Stream displays a log flow matching the defined query. | | Option 18 | columns | [string] | Which columns to display on the widget. | | Option 18 | description | string | The description of the widget. | | Option 18 | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | Option 18 | logset | string | **DEPRECATED**: ID of the log set to use. | | Option 18 | message_display | enum | Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg` | | Option 18 | query | string | Query to filter the log stream with. | | Option 18 | show_date_column | boolean | Whether to show the date column or not | | Option 18 | show_message_column | boolean | Whether to show the message column or not | | Option 18 | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 18 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 18 | title | string | Title of the widget. | | Option 18 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 18 | title_size | string | Size of the title. | | Option 18 | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream` | | definition | Option 19 | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | Option 19 | color_preference | enum | Which color to use on the widget. Allowed enum values: `background,text` | | Option 19 | count | int64 | **DEPRECATED**: The number of monitors to display. | | Option 19 | description | string | The description of the widget. | | Option 19 | display_format | enum | What to display on the widget. Allowed enum values: `counts,countsAndList,list` | | Option 19 | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | Option 19 | query [*required*] | string | Query to filter the monitors with. | | Option 19 | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | Option 19 | show_priority | boolean | Whether to show the priorities column. | | Option 19 | sort | enum | Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc` | | Option 19 | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | Option 19 | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors,groups,combined` | | Option 19 | title | string | Title of the widget. | | Option 19 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 19 | title_size | string | Size of the title. | | Option 19 | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status` | | definition | Option 20 | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | Option 20 | background_color | string | Background color of the note. | | Option 20 | content [*required*] | string | Content of the note. | | Option 20 | font_size | string | Size of the text. | | Option 20 | has_padding | boolean | Whether to add padding or not. | | Option 20 | show_tick | boolean | Whether to show a tick or not. | | Option 20 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 20 | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top` | | Option 20 | tick_pos | string | Where to position the tick on an edge. | | Option 20 | type [*required*] | enum | Type of the note widget. Allowed enum values: `note` | | Option 20 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 21 | object | 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. | | Option 21 | background_color | string | Background color of the powerpack title. | | Option 21 | banner_img | string | URL of image to display as a banner for the powerpack. | | Option 21 | powerpack_id [*required*] | string | UUID of the associated powerpack. | | Option 21 | show_title | boolean | Whether to show the title or not. | | Option 21 | template_variables | object | Powerpack template variables. | | template_variables | controlled_by_powerpack | [object] | Template variables controlled at the powerpack level. | | controlled_by_powerpack | name [*required*] | string | The name of the variable. | | controlled_by_powerpack | prefix | string | The tag prefix associated with the variable. | | controlled_by_powerpack | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | template_variables | controlled_externally | [object] | Template variables controlled by the external resource, such as the dashboard this powerpack is on. | | controlled_externally | name [*required*] | string | The name of the variable. | | controlled_externally | prefix | string | The tag prefix associated with the variable. | | controlled_externally | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | Option 21 | title | string | Title of the widget. | | Option 21 | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack` | | definition | Option 22 | object | Query values display the current value of a given metric, APM, or log query. | | Option 22 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 22 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 22 | custom_unit | string | Display a unit of your choice on the widget. | | Option 22 | description | string | The description of the widget. | | Option 22 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 22 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 22 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 22 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 22 | title | string | Title of your widget. | | Option 22 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | title_size | string | Size of the title. | | Option 22 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | definition | Option 23 | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | Option 23 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 23 | description | string | The description of the widget. | | Option 23 | inputs | [object] | Array of workflow inputs to map to dashboard template variables. | | inputs | name [*required*] | string | Name of the workflow input. | | inputs | value [*required*] | string | Dashboard template variable. Can be suffixed with '.value' or '.key'. | | Option 23 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 23 | title | string | Title of your widget. | | Option 23 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 23 | title_size | string | Size of the title. | | Option 23 | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow` | | Option 23 | workflow_id [*required*] | string | Workflow id. | | definition | Option 24 | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | Option 24 | description | string | The description of the widget. | | Option 24 | requests [*required*] | [object] | Array of one request object to display in the widget. | | requests | query [*required*] | object | Updated SLO List widget. | | query | limit | int64 | Maximum number of results to display in the table. | | query | query_string [*required*] | string | Widget query. | | query | sort | [object] | Options for sorting results. | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `slo_list` | | Option 24 | title | string | Title of the widget. | | Option 24 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 24 | title_size | string | Size of the title. | | Option 24 | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list` | | definition | Option 25 | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | Option 25 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 25 | description | string | The description of the widget. | | Option 25 | global_time_target | string | Defined global time target. | | Option 25 | show_error_budget | boolean | Defined error budget. | | Option 25 | slo_id | string | ID of the SLO displayed. | | Option 25 | time_windows | [string] | Times being monitored. | | Option 25 | title | string | Title of the widget. | | Option 25 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 25 | title_size | string | Size of the title. | | Option 25 | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo` | | Option 25 | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both` | | Option 25 | view_type [*required*] | string | Type of view displayed by the widget. | | definition | Option 26 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 26 | color_by_groups | [string] | List of groups used for colors. | | Option 26 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 26 | description | string | The description of the widget. | | Option 26 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 26 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 26 | title | string | Title of your widget. | | Option 26 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 26 | title_size | string | Size of the title. | | Option 26 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 26 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 26 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 27 | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | Option 27 | requests [*required*] | [ ] | List of Sankey widget requests. | | requests | Option 1 | object | Sankey widget with RUM data source. | | Option 1 | query [*required*] | object | Sankey widget with RUM data source query. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | accounts | name | string | | accounts | query | string | | audience_filters | filter_condition | string | | audience_filters | segments | [object] | | segments | name | string | | segments | segment_id | string | | audience_filters | users | [object] | | users | name | string | | users | query | string | | query | data_source [*required*] | enum | Sankey widget with RUM data source. Allowed enum values: `rum,product_analytics` | | query | entries_per_step | int64 | Entries per step. | | query | join_keys | object | Join keys. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | query | mode [*required*] | enum | Sankey mode for RUM queries. Allowed enum values: `source,target` | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | | occurrences | operator | string | | occurrences | value | string | | query | query_string [*required*] | string | Query string. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | Option 1 | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | requests | Option 2 | object | Sankey widget request for network data source. | | Option 2 | query [*required*] | object | Query configuration for Sankey network widget. | | query | compute | object | Compute aggregation for network queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Option 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent` | | aggregation | Option 2 | string | Percentile aggregation. | | compute | metric [*required*] | string | Metric to aggregate. | | query | data_source [*required*] | enum | Network data source type. Allowed enum values: `network_device_flows,network` | | query | group_by [*required*] | [string] | Fields to group by. | | query | limit [*required*] | int64 | Maximum number of results. | | query | mode | enum | Sankey mode for network queries. Allowed enum values: `target` | | query | query_string [*required*] | string | Query string for filtering network data. | | query | should_exclude_missing | boolean | Whether to exclude missing values. | | query | sort | object | Sort configuration for network queries. | | sort | field | string | Field to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey` | | Option 27 | show_other_links | boolean | Whether to show links for "other" category. | | Option 27 | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | Option 27 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 27 | title | string | Title of your widget. | | Option 27 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 27 | title_size | string | Size of the title. | | Option 27 | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | definition | Option 28 | object | This widget displays a map of a service to all of the services that call it, and all of the services that it calls. | | Option 28 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 28 | description | string | The description of the widget. | | Option 28 | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | Option 28 | service [*required*] | string | The ID of the service you want to map. | | Option 28 | title | string | The title of your widget. | | Option 28 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 28 | title_size | string | Size of the title. | | Option 28 | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap` | | definition | Option 29 | object | The service summary displays the graphs of a chosen service in your dashboard. | | Option 29 | description | string | The description of the widget. | | Option 29 | display_format | enum | Number of columns to display. Allowed enum values: `one_column,two_column,three_column` | | Option 29 | env [*required*] | string | APM environment. | | Option 29 | service [*required*] | string | APM service. | | Option 29 | show_breakdown | boolean | Whether to show the latency breakdown or not. | | Option 29 | show_distribution | boolean | Whether to show the latency distribution or not. | | Option 29 | show_errors | boolean | Whether to show the error metrics or not. | | Option 29 | show_hits | boolean | Whether to show the hits metrics or not. | | Option 29 | show_latency | boolean | Whether to show the latency metrics or not. | | Option 29 | show_resource_list | boolean | Whether to show the resource list or not. | | Option 29 | size_format | enum | Size of the widget. Allowed enum values: `small,medium,large` | | Option 29 | span_name [*required*] | string | APM span name. | | Option 29 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 29 | title | string | Title of the widget. | | Option 29 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 29 | title_size | string | Size of the title. | | Option 29 | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service` | | definition | Option 30 | object | The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) | | Option 30 | has_uniform_y_axes | boolean | Normalize y axes across graphs | | Option 30 | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg` | | Option 30 | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | Option 1 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 1 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 1 | description | string | The description of the widget. | | Option 1 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 1 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | Title of your widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | source_widget_definition | Option 2 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 2 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 2 | description | string | The description of the widget. | | Option 2 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 2 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of the title. | | Option 2 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | source_widget_definition | Option 3 | object | This visualization displays a series of values by country on a world map. | | Option 3 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 3 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | The title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | The size of the title. | | Option 3 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 3 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | source_widget_definition | Option 4 | object | Query values display the current value of a given metric, APM, or log query. | | Option 4 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | custom_unit | string | Display a unit of your choice on the widget. | | Option 4 | description | string | The description of the widget. | | Option 4 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 4 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 4 | title | string | Title of your widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | source_widget_definition | Option 5 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 5 | color_by_groups | [string] | List of groups used for colors. | | Option 5 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 5 | description | string | The description of the widget. | | Option 5 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of your widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 5 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 5 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 6 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 6 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | hide_total | boolean | Show the total value in this widget. | | Option 6 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 6 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of your widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | source_widget_definition | Option 7 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 7 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 7 | description | string | The description of the widget. | | Option 7 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 7 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of your widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | source_widget_definition | Option 8 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 8 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 8 | description | string | The description of the widget. | | Option 8 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 8 | legend_columns | [string] | Columns displayed in the legend. | | Option 8 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 8 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 8 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 8 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 8 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 8 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of your widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 8 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 9 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 9 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 9 | description | string | The description of the widget. | | Option 9 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 9 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 9 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 9 | title | string | Title of your widget. | | Option 9 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | title_size | string | Size of the title. | | Option 9 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | source_widget_definition | Option 10 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 10 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 10 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 10 | description | string | The description of the widget. | | Option 10 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 10 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 10 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | Title of your widget. | | Option 10 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | Option 30 | split_config [*required*] | object | Encapsulates all user choices about how to split a graph. | | split_config | limit [*required*] | int64 | Maximum number of graphs to display in the widget. | | split_config | sort [*required*] | object | Controls the order in which graphs appear in the split. | | sort | compute | object | Defines the metric and aggregation used as the sort value. | | compute | aggregation [*required*] | string | How to aggregate the sort metric for the purposes of ordering. | | compute | metric [*required*] | string | The metric to use for sorting graphs. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | split_config | split_dimensions [*required*] | [object] | The dimension(s) on which to split the graph | | split_dimensions | one_graph_per [*required*] | string | The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. | | split_config | static_splits | [array] | Manual selection of tags making split graph widget static | | Option 30 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 30 | title | string | Title of your widget. | | Option 30 | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group` | | definition | Option 31 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 31 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 31 | description | string | The description of the widget. | | Option 31 | hide_total | boolean | Show the total value in this widget. | | Option 31 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 31 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 31 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 31 | title | string | Title of your widget. | | Option 31 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 31 | title_size | string | Size of the title. | | Option 31 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | definition | Option 32 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 32 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 32 | description | string | The description of the widget. | | Option 32 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 32 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 32 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 32 | title | string | Title of your widget. | | Option 32 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 32 | title_size | string | Size of the title. | | Option 32 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | definition | Option 33 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 33 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 33 | description | string | The description of the widget. | | Option 33 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 33 | legend_columns | [string] | Columns displayed in the legend. | | Option 33 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 33 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 33 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 33 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 33 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 33 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 33 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 33 | title | string | Title of your widget. | | Option 33 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 33 | title_size | string | Size of the title. | | Option 33 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 33 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 34 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 34 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 34 | description | string | The description of the widget. | | Option 34 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 34 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 34 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 34 | title | string | Title of your widget. | | Option 34 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 34 | title_size | string | Size of the title. | | Option 34 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | definition | Option 35 | object | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Option 35 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 35 | description | string | The description of the widget. | | Option 35 | requests [*required*] | [object] | One or more Topology requests. | | requests | query | object | Query to service-based topology data sources like the service map or data streams. | | query | data_source | enum | Name of the data source Allowed enum values: `data_streams,service_map` | | query | filters | [string] | Your environment and primary tag (or * if enabled for your account). | | query | service | string | Name of the service | | requests | request_type | enum | Widget request type. Allowed enum values: `topology` | | Option 35 | title | string | Title of your widget. | | Option 35 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 35 | title_size | string | Size of the title. | | Option 35 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map` | | definition | Option 36 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 36 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 36 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 36 | description | string | The description of the widget. | | Option 36 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 36 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 36 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 36 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 36 | title | string | Title of your widget. | | Option 36 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | definition | Option 37 | object | Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. | | Option 37 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 37 | requests [*required*] | [ ] | List of data requests for the wildcard widget. | | requests | Option 1 | object | An updated treemap widget. | | Option 1 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Option 1 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 1 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | Option 2 | object | Updated timeseries widget. | | Option 2 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | Option 2 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 2 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Option 2 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Option 2 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 2 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 2 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 2 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 2 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | requests | Option 3 | object | Updated list stream widget. | | Option 3 | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | Option 3 | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | Option 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | requests | Option 4 | object | Updated distribution widget. | | Option 4 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | Option 4 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 4 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 4 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 4 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 4 | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | Option 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | Option 4 | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | Option 4 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 37 | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See [https://vega.github.io/vega-lite/](https://vega.github.io/vega-lite/) for the full grammar reference. | | specification | contents [*required*] | object | The Vega or Vega-Lite JSON specification object. | | specification | type [*required*] | enum | Type of specification used by the wildcard widget. Allowed enum values: `vega,vega-lite` | | Option 37 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 37 | title | string | Title of the widget. | | Option 37 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 37 | title_size | string | Size of the title. | | Option 37 | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard` | | widgets | id | int64 | ID of the widget. | | widgets | layout | object | The layout for a widget on a `free` or **new dashboard layout** dashboard. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | is_column_break | boolean | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | {% /tab %} {% tab title="Example" %} ##### ```json { "layout_type": "ordered", "title": "Example-Dashboard with list_stream widget", "description": "Updated description", "widgets": [ { "definition": { "type": "list_stream", "requests": [ { "columns": [ { "width": "auto", "field": "timestamp" } ], "query": { "data_source": "apm_issue_stream", "query_string": "" }, "response_format": "event_list" } ] } } ] } ``` ##### ```json { "layout_type": "ordered", "title": "Example-Dashboard with list_stream widget", "description": "Updated description", "tags": [ "team:foo", "team:bar" ], "widgets": [ { "definition": { "type": "list_stream", "requests": [ { "columns": [ { "width": "auto", "field": "timestamp" } ], "query": { "data_source": "apm_issue_stream", "query_string": "" }, "response_format": "event_list" } ] } } ] } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} 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. | Parent field | Field | Type | Description | | ------------------------- | ------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | author_handle | string | Identifier of the dashboard author. | | | author_name | string | Name of the dashboard author. | | | created_at | date-time | Creation date of the dashboard. | | | description | string | Description of the dashboard. | | | id | string | ID of the dashboard. | | | is_read_only | boolean | **DEPRECATED**: 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 [*required*] | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | | modified_at | date-time | Modification date of the dashboard. | | | notify_list | [string] | List of handles of users to notify when changes are made to this dashboard. | | | reflow_type | enum | 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. Allowed enum values: `auto,fixed` | | | 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 | [object] | List of tabs for organizing dashboard widgets into groups. | | tabs | id [*required*] | uuid | UUID of the tab. | | tabs | name [*required*] | string | Name of the tab. | | tabs | widget_ids [*required*] | [integer] | 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] | List of team names representing ownership of a dashboard. | | | template_variable_presets | [object] | Array of template variables saved views. | | template_variable_presets | name | string | The name of the variable. | | template_variable_presets | template_variables | [object] | List of variables. | | template_variables | name | string | The name of the variable. | | template_variables | value | string | **DEPRECATED**: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with `values`. | | template_variables | 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 | [object] | List of template variables for this dashboard. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with `defaults`. | | template_variables | 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`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | prefix | string | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | | template_variables | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | | title [*required*] | string | Title of the dashboard. | | | url | string | The URL of the dashboard. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). | | definition | Option 1 | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | Option 1 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 1 | description | string | The description of the widget. | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | The title of the widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph` | | Option 1 | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries,toplist` | | definition | Option 2 | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | Option 2 | alert_id [*required*] | string | ID of the alert to use in the widget. | | Option 2 | description | string | The description of the widget. | | Option 2 | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | Option 2 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of value in the widget. | | Option 2 | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value` | | Option 2 | unit | string | Unit to display with the value. | | definition | Option 3 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 3 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 3 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | Title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | Size of the title. | | Option 3 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | definition | Option 4 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | description | string | The description of the widget. | | Option 4 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | title | string | Title of the widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | definition | Option 5 | object | Check status shows the current status or number of results for any check performed. | | Option 5 | check [*required*] | string | Name of the check to use in the widget. | | Option 5 | description | string | The description of the widget. | | Option 5 | group | string | Group reporting a single check. | | Option 5 | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | Option 5 | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check,cluster` | | Option 5 | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of the widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status` | | definition | Option 6 | object | 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. | | Option 6 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 6 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | requests | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | requests | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of the widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution` | | Option 6 | xaxis | object | X Axis controls for the distribution widget. | | xaxis | include_zero | boolean | True includes zero. | | xaxis | max | string | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | min | string | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | | xaxis | num_buckets | int64 | Number of value buckets to target, also known as the resolution of the value bins. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`. | | Option 6 | yaxis | object | Y Axis controls for the distribution widget. | | yaxis | include_zero | boolean | True includes zero. | | yaxis | label | string | The label of the axis to display on the graph. | | yaxis | max | string | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. | | definition | Option 7 | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | Option 7 | description | string | The description of the widget. | | Option 7 | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | Option 7 | query [*required*] | string | Query to filter the event stream with. | | Option 7 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of the widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream` | | definition | Option 8 | object | 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. | | Option 8 | description | string | The description of the widget. | | Option 8 | query [*required*] | string | Query to filter the event timeline with. | | Option 8 | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of the widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline` | | definition | Option 9 | object | Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard. | | Option 9 | 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`. | | Option 9 | color | string | Color of the text. | | Option 9 | font_size | string | Size of the text. | | Option 9 | text [*required*] | string | Text to display. | | Option 9 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text` | | definition | Option 10 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Option 10 | description | string | The description of the widget. | | Option 10 | requests [*required*] | [object] | Request payload used to query items. | | requests | query [*required*] | object | Updated funnel widget. | | query | data_source [*required*] | enum | Source from which to query items to display in the funnel. Allowed enum values: `rum` | | query | query_string [*required*] | string | The widget query. | | query | steps [*required*] | [object] | List of funnel steps. | | steps | facet [*required*] | string | The facet of the step. | | steps | value [*required*] | string | The value of the step. | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `funnel` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | The title of the widget. | | Option 10 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 10 | title_size | string | The size of the title. | | Option 10 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel` | | definition | Option 11 | object | This visualization displays a series of values by country on a world map. | | Option 11 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 11 | description | string | The description of the widget. | | Option 11 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 11 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 11 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 11 | title | string | The title of your widget. | | Option 11 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 11 | title_size | string | The size of the title. | | Option 11 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 11 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | definition | Option 12 | object | 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. | | Option 12 | 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`. | | Option 12 | banner_img | string | URL of image to display as a banner for the group. | | Option 12 | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered` | | Option 12 | show_title | boolean | Whether to show the title or not. | | Option 12 | title | string | Title of the widget. | | Option 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 12 | type [*required*] | enum | Type of the group widget. Allowed enum values: `group` | | Option 12 | widgets [*required*] | [object] | List of widget groups. | | definition | Option 13 | object | 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. | | Option 13 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 13 | description | string | The description of the widget. | | Option 13 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 13 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 13 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 13 | requests [*required*] | [object] | List of widget types. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | search [*required*] | string | The query being made on the event. | | event_query | tags_execution [*required*] | string | The execution method for multi-value filters. Can be either and or or. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | A formula and functions metrics query. | | query | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | query | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | query | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | query | name [*required*] | string | Name of the query for use in formulas. | | query | query [*required*] | string | Metrics query definition. | | query | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | requests | request_type | enum | Applicable only for distribution of point values for distribution metrics. Allowed enum values: `histogram` | | requests | response_format | enum | Applicable only for distribution of aggregated grouped queries. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 13 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 13 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 13 | title | string | Title of the widget. | | Option 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 13 | title_size | string | Size of the title. | | Option 13 | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap` | | Option 13 | xaxis | object | X Axis controls for the heat map widget. | | xaxis | num_buckets | int64 | 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). | | Option 13 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 14 | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | Option 14 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 14 | description | string | The description of the widget. | | Option 14 | group | [string] | List of tag prefixes to group by. | | Option 14 | no_group_hosts | boolean | Whether to show the hosts that don't fit in a group. | | Option 14 | no_metric_hosts | boolean | Whether to show the hosts with no metrics. | | Option 14 | node_type | enum | Which type of node to use in the map. Allowed enum values: `host,container` | | Option 14 | notes | string | Notes on the title. | | Option 14 | requests [*required*] | object | List of definitions. | | requests | fill | object | Updated host map. | | fill | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | fill | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | q | string | Query definition. | | fill | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | fill | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | size | object | Updated host map. | | size | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | size | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | q | string | Query definition. | | size | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | size | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 14 | scope | [string] | List of tags used to filter the map. | | Option 14 | style | object | The style to apply to the widget. | | style | fill_max | string | Max value to use to color the map. | | style | fill_min | string | Min value to use to color the map. | | style | palette | string | Color palette to apply to the widget. | | style | palette_flip | boolean | Whether to flip the palette tones. | | Option 14 | title | string | Title of the widget. | | Option 14 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 14 | title_size | string | Size of the title. | | Option 14 | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap` | | definition | Option 15 | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | Option 15 | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe` | | Option 15 | url [*required*] | string | URL of the iframe. | | definition | Option 16 | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | Option 16 | has_background | boolean | Whether to display a background or not. | | Option 16 | has_border | boolean | Whether to display a border or not. | | Option 16 | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center,left,right` | | Option 16 | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm,md,lg,small,large` | | Option 16 | sizing | enum | 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. Allowed enum values: `fill,contain,cover,none,scale-down,zoom,fit,center` | | Option 16 | type [*required*] | enum | Type of the image widget. Allowed enum values: `image` | | Option 16 | url [*required*] | string | URL of the image. | | Option 16 | url_dark_theme | string | URL of the image in dark mode. | | Option 16 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 17 | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | Option 17 | description | string | The description of the widget. | | Option 17 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 17 | requests [*required*] | [object] | Request payload used to query items. | | requests | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | Option 17 | show_legend | boolean | Whether or not to display the legend on this widget. | | Option 17 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 17 | title | string | Title of the widget. | | Option 17 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 17 | title_size | string | Size of the title. | | Option 17 | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream` | | definition | Option 18 | object | The Log Stream displays a log flow matching the defined query. | | Option 18 | columns | [string] | Which columns to display on the widget. | | Option 18 | description | string | The description of the widget. | | Option 18 | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | Option 18 | logset | string | **DEPRECATED**: ID of the log set to use. | | Option 18 | message_display | enum | Amount of log lines to display Allowed enum values: `inline,expanded-md,expanded-lg` | | Option 18 | query | string | Query to filter the log stream with. | | Option 18 | show_date_column | boolean | Whether to show the date column or not | | Option 18 | show_message_column | boolean | Whether to show the message column or not | | Option 18 | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 18 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 18 | title | string | Title of the widget. | | Option 18 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 18 | title_size | string | Size of the title. | | Option 18 | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream` | | definition | Option 19 | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | Option 19 | color_preference | enum | Which color to use on the widget. Allowed enum values: `background,text` | | Option 19 | count | int64 | **DEPRECATED**: The number of monitors to display. | | Option 19 | description | string | The description of the widget. | | Option 19 | display_format | enum | What to display on the widget. Allowed enum values: `counts,countsAndList,list` | | Option 19 | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | Option 19 | query [*required*] | string | Query to filter the monitors with. | | Option 19 | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | Option 19 | show_priority | boolean | Whether to show the priorities column. | | Option 19 | sort | enum | Widget sorting methods. Allowed enum values: `name,group,status,tags,triggered,group,asc,group,desc,name,asc,name,desc,status,asc` | | Option 19 | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | Option 19 | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors,groups,combined` | | Option 19 | title | string | Title of the widget. | | Option 19 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 19 | title_size | string | Size of the title. | | Option 19 | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status` | | definition | Option 20 | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | Option 20 | background_color | string | Background color of the note. | | Option 20 | content [*required*] | string | Content of the note. | | Option 20 | font_size | string | Size of the text. | | Option 20 | has_padding | boolean | Whether to add padding or not. | | Option 20 | show_tick | boolean | Whether to show a tick or not. | | Option 20 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 20 | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom,left,right,top` | | Option 20 | tick_pos | string | Where to position the tick on an edge. | | Option 20 | type [*required*] | enum | Type of the note widget. Allowed enum values: `note` | | Option 20 | vertical_align | enum | Vertical alignment. Allowed enum values: `center,top,bottom` | | definition | Option 21 | object | 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. | | Option 21 | background_color | string | Background color of the powerpack title. | | Option 21 | banner_img | string | URL of image to display as a banner for the powerpack. | | Option 21 | powerpack_id [*required*] | string | UUID of the associated powerpack. | | Option 21 | show_title | boolean | Whether to show the title or not. | | Option 21 | template_variables | object | Powerpack template variables. | | template_variables | controlled_by_powerpack | [object] | Template variables controlled at the powerpack level. | | controlled_by_powerpack | name [*required*] | string | The name of the variable. | | controlled_by_powerpack | prefix | string | The tag prefix associated with the variable. | | controlled_by_powerpack | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | template_variables | controlled_externally | [object] | Template variables controlled by the external resource, such as the dashboard this powerpack is on. | | controlled_externally | name [*required*] | string | The name of the variable. | | controlled_externally | prefix | string | The tag prefix associated with the variable. | | controlled_externally | values [*required*] | [string] | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. | | Option 21 | title | string | Title of the widget. | | Option 21 | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack` | | definition | Option 22 | object | Query values display the current value of a given metric, APM, or log query. | | Option 22 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 22 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 22 | custom_unit | string | Display a unit of your choice on the widget. | | Option 22 | description | string | The description of the widget. | | Option 22 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 22 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 22 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 22 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 22 | title | string | Title of your widget. | | Option 22 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 22 | title_size | string | Size of the title. | | Option 22 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | definition | Option 23 | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | Option 23 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 23 | description | string | The description of the widget. | | Option 23 | inputs | [object] | Array of workflow inputs to map to dashboard template variables. | | inputs | name [*required*] | string | Name of the workflow input. | | inputs | value [*required*] | string | Dashboard template variable. Can be suffixed with '.value' or '.key'. | | Option 23 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 23 | title | string | Title of your widget. | | Option 23 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 23 | title_size | string | Size of the title. | | Option 23 | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow` | | Option 23 | workflow_id [*required*] | string | Workflow id. | | definition | Option 24 | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | Option 24 | description | string | The description of the widget. | | Option 24 | requests [*required*] | [object] | Array of one request object to display in the widget. | | requests | query [*required*] | object | Updated SLO List widget. | | query | limit | int64 | Maximum number of results to display in the table. | | query | query_string [*required*] | string | Widget query. | | query | sort | [object] | Options for sorting results. | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | request_type [*required*] | enum | Widget request type. Allowed enum values: `slo_list` | | Option 24 | title | string | Title of the widget. | | Option 24 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 24 | title_size | string | Size of the title. | | Option 24 | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list` | | definition | Option 25 | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | Option 25 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 25 | description | string | The description of the widget. | | Option 25 | global_time_target | string | Defined global time target. | | Option 25 | show_error_budget | boolean | Defined error budget. | | Option 25 | slo_id | string | ID of the SLO displayed. | | Option 25 | time_windows | [string] | Times being monitored. | | Option 25 | title | string | Title of the widget. | | Option 25 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 25 | title_size | string | Size of the title. | | Option 25 | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo` | | Option 25 | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall,component,both` | | Option 25 | view_type [*required*] | string | Type of view displayed by the widget. | | definition | Option 26 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 26 | color_by_groups | [string] | List of groups used for colors. | | Option 26 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 26 | description | string | The description of the widget. | | Option 26 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 26 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 26 | title | string | Title of your widget. | | Option 26 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 26 | title_size | string | Size of the title. | | Option 26 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 26 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 26 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 27 | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | Option 27 | requests [*required*] | [ ] | List of Sankey widget requests. | | requests | Option 1 | object | Sankey widget with RUM data source. | | Option 1 | query [*required*] | object | Sankey widget with RUM data source query. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | accounts | name | string | | accounts | query | string | | audience_filters | filter_condition | string | | audience_filters | segments | [object] | | segments | name | string | | segments | segment_id | string | | audience_filters | users | [object] | | users | name | string | | users | query | string | | query | data_source [*required*] | enum | Sankey widget with RUM data source. Allowed enum values: `rum,product_analytics` | | query | entries_per_step | int64 | Entries per step. | | query | join_keys | object | Join keys. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | query | mode [*required*] | enum | Sankey mode for RUM queries. Allowed enum values: `source,target` | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | | occurrences | operator | string | | occurrences | value | string | | query | query_string [*required*] | string | Query string. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | Option 1 | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | requests | Option 2 | object | Sankey widget request for network data source. | | Option 2 | query [*required*] | object | Query configuration for Sankey network widget. | | query | compute | object | Compute aggregation for network queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Option 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg,cardinality,count,delta,earliest,latest,max,median,min,most_frequent` | | aggregation | Option 2 | string | Percentile aggregation. | | compute | metric [*required*] | string | Metric to aggregate. | | query | data_source [*required*] | enum | Network data source type. Allowed enum values: `network_device_flows,network` | | query | group_by [*required*] | [string] | Fields to group by. | | query | limit [*required*] | int64 | Maximum number of results. | | query | mode | enum | Sankey mode for network queries. Allowed enum values: `target` | | query | query_string [*required*] | string | Query string for filtering network data. | | query | should_exclude_missing | boolean | Whether to exclude missing values. | | query | sort | object | Sort configuration for network queries. | | sort | field | string | Field to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey` | | Option 27 | show_other_links | boolean | Whether to show links for "other" category. | | Option 27 | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | Option 27 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 27 | title | string | Title of your widget. | | Option 27 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 27 | title_size | string | Size of the title. | | Option 27 | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey` | | definition | Option 28 | object | This widget displays a map of a service to all of the services that call it, and all of the services that it calls. | | Option 28 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 28 | description | string | The description of the widget. | | Option 28 | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | Option 28 | service [*required*] | string | The ID of the service you want to map. | | Option 28 | title | string | The title of your widget. | | Option 28 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 28 | title_size | string | Size of the title. | | Option 28 | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap` | | definition | Option 29 | object | The service summary displays the graphs of a chosen service in your dashboard. | | Option 29 | description | string | The description of the widget. | | Option 29 | display_format | enum | Number of columns to display. Allowed enum values: `one_column,two_column,three_column` | | Option 29 | env [*required*] | string | APM environment. | | Option 29 | service [*required*] | string | APM service. | | Option 29 | show_breakdown | boolean | Whether to show the latency breakdown or not. | | Option 29 | show_distribution | boolean | Whether to show the latency distribution or not. | | Option 29 | show_errors | boolean | Whether to show the error metrics or not. | | Option 29 | show_hits | boolean | Whether to show the hits metrics or not. | | Option 29 | show_latency | boolean | Whether to show the latency metrics or not. | | Option 29 | show_resource_list | boolean | Whether to show the resource list or not. | | Option 29 | size_format | enum | Size of the widget. Allowed enum values: `small,medium,large` | | Option 29 | span_name [*required*] | string | APM span name. | | Option 29 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 29 | title | string | Title of the widget. | | Option 29 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 29 | title_size | string | Size of the title. | | Option 29 | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service` | | definition | Option 30 | object | The split graph widget allows you to create repeating units of a graph - one for each value in a group (for example: one per service) | | Option 30 | has_uniform_y_axes | boolean | Normalize y axes across graphs | | Option 30 | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs,sm,md,lg` | | Option 30 | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | Option 1 | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | Option 1 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 1 | description | string | The description of the widget. | | Option 1 | requests [*required*] | [object] | List of bar chart widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 1 | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | Option 1 | object | Bar chart widget stacked display options. | | Option 1 | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Bar chart widget flat display. | | Option 2 | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute,relative` | | Option 1 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 1 | title | string | Title of your widget. | | Option 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 1 | title_size | string | Size of the title. | | Option 1 | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart` | | source_widget_definition | Option 2 | object | The Change graph shows you the change in a value over the time period chosen. | | Option 2 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 2 | description | string | The description of the widget. | | Option 2 | requests [*required*] | [object] | 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`. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | change_type | enum | Show the absolute or the relative change. Allowed enum values: `absolute,relative` | | requests | compare_to | enum | Timeframe used for the change comparison. Allowed enum values: `hour_before,day_before,week_before,month_before` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | increase_good | boolean | Whether to show increase as good. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order_by | enum | What to order by. Allowed enum values: `change,name,present,past` | | requests | order_dir | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | show_present | boolean | Whether to show the present value. | | Option 2 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 2 | title | string | Title of the widget. | | Option 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 2 | title_size | string | Size of the title. | | Option 2 | type [*required*] | enum | Type of the change widget. Allowed enum values: `change` | | source_widget_definition | Option 3 | object | This visualization displays a series of values by country on a world map. | | Option 3 | custom_links | [object] | A list of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 3 | description | string | The description of the widget. | | Option 3 | requests [*required*] | [object] | 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`. | | requests | columns | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | requests | conditional_formats | [object] | Threshold (numeric) conditional formatting rules may be used by a regions layer. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | query | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | The style to apply to the request for points layer. | | style | color_by | string | The category to color the points by. | | requests | text_formats | [object] | Text formatting rules may be used by a points layer. | | text_formats | custom_bg_color | string | Hex representation of the custom background color. Used with custom background palette option. | | text_formats | custom_fg_color | string | Hex representation of the custom text color. Used with custom text palette option. | | text_formats | match [*required*] | object | Match rule for the table widget text format. | | match | type [*required*] | enum | Match or compare option. Allowed enum values: `is,is_not,contains,does_not_contain,starts_with,ends_with` | | match | value [*required*] | string | Table Widget Match String. | | text_formats | palette | enum | Color-on-color palette to highlight replaced text. Allowed enum values: `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` | | text_formats | replace | | Replace rule for the table widget text format. | | replace | Option 1 | object | Match All definition. | | Option 1 | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all` | | Option 1 | with [*required*] | string | Replace All type. | | replace | Option 2 | object | Match Sub-string definition. | | Option 2 | substring [*required*] | string | Text that will be replaced. | | Option 2 | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring` | | Option 2 | with [*required*] | string | Text that will replace original sub-string. | | Option 3 | style [*required*] | object | The style to apply to the widget. | | style | palette [*required*] | string | The color palette to apply to the widget. | | style | palette_flip [*required*] | boolean | Whether to flip the palette tones. | | Option 3 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 3 | title | string | The title of your widget. | | Option 3 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 3 | title_size | string | The size of the title. | | Option 3 | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap` | | Option 3 | view [*required*] | object | The view of the world that the map should render. | | view | focus [*required*] | string | 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`). | | source_widget_definition | Option 4 | object | Query values display the current value of a given metric, APM, or log query. | | Option 4 | autoscale | boolean | Whether to use auto-scaling or not. | | Option 4 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 4 | custom_unit | string | Display a unit of your choice on the widget. | | Option 4 | description | string | The description of the widget. | | Option 4 | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | Option 4 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | text_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 4 | timeseries_background | object | Set a timeseries on the widget background. | | timeseries_background | type [*required*] | enum | Timeseries is made using an area or bars. Allowed enum values: `bars,area` | | timeseries_background | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 4 | title | string | Title of your widget. | | Option 4 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 4 | title_size | string | Size of the title. | | Option 4 | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value` | | source_widget_definition | Option 5 | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | Option 5 | color_by_groups | [string] | List of groups used for colors. | | Option 5 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 5 | description | string | The description of the widget. | | Option 5 | requests [*required*] | object | Widget definition. | | requests | table | object | Scatterplot request containing formulas and functions. | | table | formulas | [object] | List of Scatterplot formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Dimension of the Scatterplot. Allowed enum values: `x,y,radius,color` | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | table | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | table | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | x | object | Updated scatter plot. | | x | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | x | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | x | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | q | string | Query definition. | | x | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | x | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | y | object | Updated scatter plot. | | y | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum` | | y | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | y | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | q | string | Query definition. | | y | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | y | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 5 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 5 | title | string | Title of your widget. | | Option 5 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 5 | title_size | string | Size of the title. | | Option 5 | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot` | | Option 5 | xaxis | object | Axis controls for the widget. | | xaxis | include_zero | boolean | Set to `true` to include zero. | | xaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | xaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 5 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 6 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 6 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 6 | description | string | The description of the widget. | | Option 6 | hide_total | boolean | Show the total value in this widget. | | Option 6 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 6 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 6 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 6 | title | string | Title of your widget. | | Option 6 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 6 | title_size | string | Size of the title. | | Option 6 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | source_widget_definition | Option 7 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 7 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 7 | description | string | The description of the widget. | | Option 7 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 7 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 7 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 7 | title | string | Title of your widget. | | Option 7 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 7 | title_size | string | Size of the title. | | Option 7 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | source_widget_definition | Option 8 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 8 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 8 | description | string | The description of the widget. | | Option 8 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 8 | legend_columns | [string] | Columns displayed in the legend. | | Option 8 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 8 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 8 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 8 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 8 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 8 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 8 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 8 | title | string | Title of your widget. | | Option 8 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 8 | title_size | string | Size of the title. | | Option 8 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 8 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | source_widget_definition | Option 9 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 9 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 9 | description | string | The description of the widget. | | Option 9 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 9 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 9 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 9 | title | string | Title of your widget. | | Option 9 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 9 | title_size | string | Size of the title. | | Option 9 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | source_widget_definition | Option 10 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 10 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 10 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 10 | description | string | The description of the widget. | | Option 10 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 10 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 10 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 10 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 10 | title | string | Title of your widget. | | Option 10 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | Option 30 | split_config [*required*] | object | Encapsulates all user choices about how to split a graph. | | split_config | limit [*required*] | int64 | Maximum number of graphs to display in the widget. | | split_config | sort [*required*] | object | Controls the order in which graphs appear in the split. | | sort | compute | object | Defines the metric and aggregation used as the sort value. | | compute | aggregation [*required*] | string | How to aggregate the sort metric for the purposes of ordering. | | compute | metric [*required*] | string | The metric to use for sorting graphs. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | split_config | split_dimensions [*required*] | [object] | The dimension(s) on which to split the graph | | split_dimensions | one_graph_per [*required*] | string | The system interprets this attribute differently depending on the data source of the query being split. For metrics, it's a tag. For the events platform, it's an attribute or tag. | | split_config | static_splits | [array] | Manual selection of tags making split graph widget static | | Option 30 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 30 | title | string | Title of your widget. | | Option 30 | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group` | | definition | Option 31 | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | Option 31 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 31 | description | string | The description of the widget. | | Option 31 | hide_total | boolean | Show the total value in this widget. | | Option 31 | legend | | Configuration of the legend. | | legend | Option 1 | object | Configuration of table-based legend. | | Option 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table,none` | | legend | Option 2 | object | Configuration of inline or automatic legends. | | Option 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Option 2 | hide_value | boolean | Whether to hide the values of the groups. | | Option 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline,automatic` | | Option 31 | requests [*required*] | [object] | List of sunburst widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 31 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 31 | title | string | Title of your widget. | | Option 31 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 31 | title_size | string | Size of the title. | | Option 31 | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst` | | definition | Option 32 | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | Option 32 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 32 | description | string | The description of the widget. | | Option 32 | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always,never,auto` | | Option 32 | requests [*required*] | [object] | Widget definition. | | requests | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | requests | alias | string | The column name (defaults to the metric name). | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | requests | cell_display_mode | [string] | A list of display modes for each table cell. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | limit | int64 | For metric queries, the number of lines to show in the table. Only one request should have this property. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Query definition. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | text_formats | [array] | List of text formats for columns produced by tags. | | Option 32 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 32 | title | string | Title of your widget. | | Option 32 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 32 | title_size | string | Size of the title. | | Option 32 | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table` | | definition | Option 33 | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | Option 33 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 33 | description | string | The description of the widget. | | Option 33 | events | [object] | **DEPRECATED**: List of widget events. Deprecated - Use `overlay` request type instead. | | events | q [*required*] | string | Query definition. | | events | tags_execution | string | The execution method for multi-value filters. | | Option 33 | legend_columns | [string] | Columns displayed in the legend. | | Option 33 | legend_layout | enum | Layout of the legend. Allowed enum values: `auto,horizontal,vertical` | | Option 33 | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | Option 33 | markers | [object] | List of markers. | | markers | display_type | string | Combination of: | | markers | label | string | Label to display over the marker. | | markers | time | string | Timestamp for the widget. | | markers | value [*required*] | string | 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). | | Option 33 | requests [*required*] | [object] | List of timeseries widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 33 | right_yaxis | object | Axis controls for the widget. | | right_yaxis | include_zero | boolean | Set to `true` to include zero. | | right_yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | right_yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | Option 33 | show_legend | boolean | (screenboard only) Show the legend for this widget. | | Option 33 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 33 | title | string | Title of your widget. | | Option 33 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 33 | title_size | string | Size of the title. | | Option 33 | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries` | | Option 33 | yaxis | object | Axis controls for the widget. | | yaxis | include_zero | boolean | Set to `true` to include zero. | | yaxis | label | string | The label of the axis to display on the graph. Only usable on Scatterplot Widgets. | | yaxis | max | string | Specifies maximum numeric value to show on the axis. Defaults to `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). | | definition | Option 34 | object | The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc. | | Option 34 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 34 | description | string | The description of the widget. | | Option 34 | requests [*required*] | [object] | List of top list widget requests. | | requests | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | requests | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | requests | sort | object | The controls for sorting the widget. | | sort | count | int64 | The number of items to limit the widget to. | | sort | order_by | [ ] | The array of items to sort the widget by in order. | | order_by | Option 1 | object | The formula to sort the widget by. | | Option 1 | index [*required*] | int64 | The index of the formula to sort by. | | Option 1 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 1 | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula` | | order_by | Option 2 | object | The group to sort the widget by. | | Option 2 | name [*required*] | string | The name of the group. | | Option 2 | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | Option 2 | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group` | | requests | style | object | Define request widget style. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | Option 34 | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | Option 1 | object | Top list widget stacked display options. | | Option 1 | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic,inline,none` | | Option 1 | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked` | | display | Option 2 | object | Top list widget flat display. | | Option 2 | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat` | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute,relative` | | Option 34 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 34 | title | string | Title of your widget. | | Option 34 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 34 | title_size | string | Size of the title. | | Option 34 | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist` | | definition | Option 35 | object | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Option 35 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 35 | description | string | The description of the widget. | | Option 35 | requests [*required*] | [object] | One or more Topology requests. | | requests | query | object | Query to service-based topology data sources like the service map or data streams. | | query | data_source | enum | Name of the data source Allowed enum values: `data_streams,service_map` | | query | filters | [string] | Your environment and primary tag (or * if enabled for your account). | | query | service | string | Name of the service | | requests | request_type | enum | Widget request type. Allowed enum values: `topology` | | Option 35 | title | string | Title of your widget. | | Option 35 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 35 | title_size | string | Size of the title. | | Option 35 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map` | | definition | Option 36 | object | The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team. | | Option 36 | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user` | | Option 36 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 36 | description | string | The description of the widget. | | Option 36 | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user,family,process` | | Option 36 | requests [*required*] | [object] | List of treemap widget requests. | | requests | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | requests | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | requests | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 36 | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu,pct_mem` | | Option 36 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 36 | title | string | Title of your widget. | | Option 36 | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap` | | definition | Option 37 | object | Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations. | | Option 37 | custom_links | [object] | List of custom links. | | custom_links | is_hidden | boolean | The flag for toggling context menu link visibility. | | custom_links | label | string | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | | custom_links | link | string | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | | custom_links | override_label | string | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | | Option 37 | requests [*required*] | [ ] | List of data requests for the wildcard widget. | | requests | Option 1 | object | An updated treemap widget. | | Option 1 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Option 1 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 1 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | requests | Option 2 | object | Updated timeseries widget. | | Option 2 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | audit_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | audit_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | audit_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | audit_query | 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) | | audit_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | audit_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area,bars,line,overlay` | | Option 2 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 2 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Option 2 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Option 2 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 2 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 2 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 2 | response_format | enum | Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. Allowed enum values: `timeseries,scalar,event_list` | | Option 2 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 2 | style | object | Define request widget style for timeseries widgets. | | style | has_value_labels | boolean | If true, the value is displayed as a label relative to the data point. | | style | line_type | enum | Type of lines displayed. Allowed enum values: `dashed,dotted,solid` | | style | line_width | enum | Width of line displayed. Allowed enum values: `normal,thick,thin` | | style | order_by | enum | How to order series in timeseries visualizations. | | style | palette | string | Color palette to apply to the widget. | | requests | Option 3 | object | Updated list stream widget. | | Option 3 | columns [*required*] | [object] | Widget columns. | | columns | field [*required*] | string | Widget column field. | | columns | width [*required*] | enum | Widget column width. Allowed enum values: `auto,compact,full` | | Option 3 | query [*required*] | object | Updated list stream widget. | | query | clustering_pattern_field_path | string | Specifies the field for logs pattern clustering. Usable only with logs_pattern_stream. | | query | compute | [object] | 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. | | compute | aggregation [*required*] | enum | Aggregation value. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. Allowed enum values: `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` | | query | event_size | enum | Size to use to display an event. Allowed enum values: `s,l` | | query | group_by | [object] | 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. | | group_by | facet [*required*] | string | Facet name. | | query | indexes | [string] | List of indexes. | | query | query_string [*required*] | string | Widget query. | | query | sort | object | Which column and order to sort by | | sort | column [*required*] | string | Facet path for the column | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | query | storage | string | Option for storage location. Feature in Private Beta. | | Option 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list` | | requests | Option 4 | object | Updated distribution widget. | | Option 4 | apm_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | apm_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | apm_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_query | 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) | | apm_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | apm_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | apm_stats_query | object | The APM stats query for table and distributions widgets. | | apm_stats_query | columns | [object] | Column properties used by the front end for display. | | columns | alias | string | A user-assigned alias for the column. | | columns | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | columns | name [*required*] | string | Column name. | | columns | order | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | apm_stats_query | env [*required*] | string | Environment name. | | apm_stats_query | name [*required*] | string | Operation name associated with service. | | apm_stats_query | primary_tag [*required*] | string | The organization's host group name and value. | | apm_stats_query | resource | string | Resource name. | | apm_stats_query | row_type [*required*] | enum | The level of detail for the request. Allowed enum values: `service,resource,span` | | apm_stats_query | service [*required*] | string | Service name. | | Option 4 | event_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | event_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | event_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | event_query | 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) | | event_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | event_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | formulas | [object] | List of formulas that operate on queries. | | formulas | alias | string | Expression alias. | | formulas | cell_display_mode | enum | Define a display mode for the table cell. Allowed enum values: `number,bar,trend` | | formulas | cell_display_mode_options | object | Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`). | | cell_display_mode_options | trend_type | enum | Trend type for the cell display mode options. Allowed enum values: `area,line,bars` | | cell_display_mode_options | y_scale | enum | Y scale for the cell display mode options. Allowed enum values: `shared,independent` | | formulas | conditional_formats | [object] | List of conditional formats. | | conditional_formats | comparator [*required*] | enum | Comparator to apply. Allowed enum values: `=,>,>=,<,<=` | | conditional_formats | custom_bg_color | string | Color palette to apply to the background, same values available as palette. | | conditional_formats | custom_fg_color | string | Color palette to apply to the foreground, same values available as palette. | | conditional_formats | hide_value | boolean | True hides values. | | conditional_formats | image_url | string | Displays an image as the background. | | conditional_formats | metric | string | Metric from the request to correlate this conditional format with. | | conditional_formats | palette [*required*] | enum | Color palette to apply. Allowed enum values: `blue,custom_bg,custom_image,custom_text,gray_on_white,grey,green,orange,red,red_on_white` | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | limit | object | Options for limiting results returned. | | limit | count | int64 | Number of results to return. | | limit | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | Option 1 | object | Canonical unit. | | Option 1 | per_unit_name | string | The name of the unit per item. | | Option 1 | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | Option 1 | unit_name | string | The name of the unit. | | unit | Option 2 | object | Custom unit. | | Option 2 | label | string | The label for the custom unit. | | Option 2 | type | enum | The type of custom unit. Allowed enum values: `custom_unit_label` | | number_format | unit_scale | object | The definition of `NumberFormatUnitScale` object. | | unit_scale | type | enum | The type of unit scale. Allowed enum values: `canonical_unit` | | unit_scale | unit_name | string | The name of the unit. | | formulas | style | object | Styling options for widget formulas. | | style | palette | string | The color palette used to display the formula. A guide to the available color palettes can be found at [https://docs.datadoghq.com/dashboards/guide/widget_colors](https://docs.datadoghq.com/dashboards/guide/widget_colors) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Option 4 | log_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | log_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | log_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | log_query | 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) | | log_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | log_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | network_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | network_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | network_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | network_query | 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) | | network_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | network_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | process_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | process_query | filter_by | [string] | List of processes. | | process_query | limit | int64 | Max number of items in the filter list. | | process_query | metric [*required*] | string | Your chosen metric. | | process_query | search_by | string | Your chosen search term. | | Option 4 | profile_metrics_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | profile_metrics_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | profile_metrics_query | 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) | | profile_metrics_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | profile_metrics_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Option 4 | queries | [ ] | List of queries that can be returned directly or used in formulas. | | queries | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | queries | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Option 3 | object | Process query using formulas and functions. | | Option 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process,container` | | Option 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Option 3 | limit | int64 | Number of hits to return. | | Option 3 | metric [*required*] | string | Process metric name. | | Option 3 | name [*required*] | string | Name of query for use in formulas. | | Option 3 | sort | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 3 | tag_filters | [string] | An array of tags to filter by. | | Option 3 | text_filter | string | Text to use as filter. | | queries | Option 4 | object | A formula and functions APM dependency stats query. | | Option 4 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 4 | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats` | | Option 4 | env [*required*] | string | APM environment. | | Option 4 | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | Option 4 | name [*required*] | string | Name of query to use in formulas. | | Option 4 | operation_name [*required*] | string | Name of operation on service. | | Option 4 | primary_tag_name | string | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog). | | Option 4 | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | Option 4 | resource_name [*required*] | string | APM resource. | | Option 4 | service [*required*] | string | APM service. | | Option 4 | stat [*required*] | enum | APM statistic. Allowed enum values: `avg_duration,avg_root_duration,avg_spans_per_trace,error_rate,pct_exec_time,pct_of_traces,total_traces_count` | | queries | Option 5 | object | APM resource stats query using formulas and functions. | | Option 5 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 5 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 5 | env [*required*] | string | APM environment. | | Option 5 | group_by | [string] | Array of fields to group results by. | | Option 5 | name [*required*] | string | Name of this query to use in formulas. | | Option 5 | operation_name | string | Name of operation on service. | | Option 5 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 5 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 5 | resource_name | string | APM resource name. | | Option 5 | service [*required*] | string | APM service name. | | Option 5 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | queries | Option 6 | object | A formula and functions APM metrics query. | | Option 6 | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics` | | Option 6 | group_by | [string] | Optional fields to group the query results by. | | Option 6 | name [*required*] | string | Name of this query to use in formulas. | | Option 6 | operation_mode | string | Optional operation mode to aggregate across operation names. | | Option 6 | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | Option 6 | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | Option 6 | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | Option 6 | resource_hash | string | The hash of a specific resource to filter by. | | Option 6 | resource_name | string | The full name of a specific resource to filter by. | | Option 6 | service | string | APM service name. | | Option 6 | span_kind | enum | Describes the relationship between the span, its parents, and its children in a trace. Allowed enum values: `consumer,server,client,producer,internal` | | Option 6 | stat [*required*] | enum | APM metric stat name. Allowed enum values: `errors,error_rate,errors_per_second,latency_avg,latency_max,latency_p50,latency_p75,latency_p90,latency_p95,latency_p99` | | queries | Option 7 | object | A formula and functions metrics query. | | Option 7 | additional_query_filters | string | Additional filters applied to the SLO query. | | Option 7 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 7 | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo` | | Option 7 | group_mode | enum | Group mode to query measures. Allowed enum values: `overall,components` | | Option 7 | measure [*required*] | enum | SLO measures queries. Allowed enum values: `good_events,bad_events,good_minutes,bad_minutes,slo_status,error_budget_remaining,burn_rate,error_budget_burndown` | | Option 7 | name | string | Name of the query for use in formulas. | | Option 7 | slo_id [*required*] | string | ID of an SLO to query measures. | | Option 7 | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric,monitor,time_slice` | | queries | Option 8 | object | A formula and functions Cloud Cost query. | | Option 8 | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg,last,max,min,sum,percentile` | | Option 8 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 8 | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost` | | Option 8 | name [*required*] | string | Name of the query for use in formulas. | | Option 8 | query [*required*] | string | Query for Cloud Cost data. | | Option 4 | query | | Query definition for Distribution Widget Histogram Request | | query | Option 1 | object | A formula and functions metrics query. | | Option 1 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg,min,max,sum,last,area,l2norm,percentile` | | Option 1 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 1 | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics` | | Option 1 | name [*required*] | string | Name of the query for use in formulas. | | Option 1 | query [*required*] | string | Metrics query definition. | | Option 1 | semantic_mode | enum | Semantic mode for metrics queries. This determines how metrics from different sources are combined or displayed. Allowed enum values: `combined,native` | | query | Option 2 | object | A formula and functions events query. | | Option 2 | compute [*required*] | object | Compute options. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Option 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs,spans,network,rum,security_signals,profiles,audit,events,ci_tests,ci_pipelines` | | Option 2 | group_by | | Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields. | | group_by | Option 1 | [object] | List of objects used to group by. | | Option 1 | facet [*required*] | string | Event facet. | | Option 1 | limit | int64 | Number of groups to return. | | Option 1 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | group_by | Option 2 | object | Flat group by configuration using multiple event facet fields. | | Option 2 | fields [*required*] | [string] | List of event facets to group by. | | Option 2 | limit | int64 | Number of groups to return. | | Option 2 | sort | object | Options for sorting group by results. | | sort | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count,cardinality,median,pc75,pc90,pc95,pc98,pc99,sum,min` | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc,desc` | | Option 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Option 2 | name [*required*] | string | Name of the query for use in formulas. | | Option 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Option 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | Option 3 | object | APM resource stats query using formulas and functions. | | Option 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Option 3 | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats` | | Option 3 | env [*required*] | string | APM environment. | | Option 3 | group_by | [string] | Array of fields to group results by. | | Option 3 | name [*required*] | string | Name of this query to use in formulas. | | Option 3 | operation_name | string | Name of operation on service. | | Option 3 | primary_tag_name | string | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See [https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog](https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog) | | Option 3 | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | Option 3 | resource_name | string | APM resource name. | | Option 3 | service [*required*] | string | APM service name. | | Option 3 | stat [*required*] | enum | APM resource stat name. Allowed enum values: `errors,error_rate,hits,latency_avg,latency_distribution,latency_max,latency_p50,latency_p75,latency_p90,latency_p95` | | Option 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram` | | Option 4 | response_format | enum | Distribution of aggregated grouped queries. Use `request_type` instead for distribution of point values from distribution metrics. Allowed enum values: `timeseries,scalar,event_list` | | Option 4 | rum_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | rum_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | rum_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | rum_query | 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) | | rum_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | rum_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | security_query | object | **DEPRECATED**: Deprecated - Use `queries` and `formulas` instead. | | security_query | compute | object | Define computation for a log query. | | compute | aggregation [*required*] | string | The aggregation method. | | compute | facet | string | Facet name. | | compute | interval | int64 | Define a time interval in seconds. | | security_query | group_by | [object] | List of tag prefixes to group by in the case of a cluster check. | | group_by | facet [*required*] | string | Facet name. | | group_by | limit | int64 | Maximum number of items in the group. | | group_by | sort | object | Define a sorting method. | | sort | aggregation [*required*] | string | The aggregation method. | | sort | facet | string | Facet name. | | sort | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc,desc` | | security_query | 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) | | security_query | multi_compute | [object] | This field is mutually exclusive with `compute`. | | multi_compute | aggregation [*required*] | string | The aggregation method. | | multi_compute | facet | string | Facet name. | | multi_compute | interval | int64 | Define a time interval in seconds. | | security_query | search | object | The query being made on the logs. | | search | query [*required*] | string | Search value to apply. | | Option 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | Option 37 | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See [https://vega.github.io/vega-lite/](https://vega.github.io/vega-lite/) for the full grammar reference. | | specification | contents [*required*] | object | The Vega or Vega-Lite JSON specification object. | | specification | type [*required*] | enum | Type of specification used by the wildcard widget. Allowed enum values: `vega,vega-lite` | | Option 37 | time | | Time setting for the widget. | | time | Option 1 | object | Wrapper for live span | | Option 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 1 | live_span | enum | The available timeframes depend on the widget you are using. Allowed enum values: `1m,5m,10m,15m,30m,1h,4h,1d,2d,1w` | | time | Option 2 | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | Option 2 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 2 | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live` | | Option 2 | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute,hour,day,week,month,year` | | Option 2 | value [*required*] | int64 | Value of the time span. | | time | Option 3 | object | Used for fixed span times, such as 'March 1 to March 7'. | | Option 3 | from [*required*] | int64 | Start time in milliseconds since epoch. | | Option 3 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Option 3 | to [*required*] | int64 | End time in milliseconds since epoch. | | Option 3 | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed` | | Option 37 | title | string | Title of the widget. | | Option 37 | title_align | enum | How to align the text on the widget. Allowed enum values: `center,left,right` | | Option 37 | title_size | string | Size of the title. | | Option 37 | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard` | | widgets | id | int64 | ID of the widget. | | widgets | layout | object | The layout for a widget on a `free` or **new dashboard layout** dashboard. | | layout | height [*required*] | int64 | The height of the widget. Should be a non-negative integer. | | layout | is_column_break | boolean | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | | layout | width [*required*] | int64 | The width of the widget. Should be a non-negative integer. | | layout | x [*required*] | int64 | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | layout | y [*required*] | int64 | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | {% /tab %} {% tab title="Example" %} ```json { "author_handle": "test@datadoghq.com", "author_name": "John Doe", "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "id": "123-abc-456", "is_read_only": false, "layout_type": "ordered", "modified_at": "2019-09-19T10:00:00.000Z", "notify_list": [], "reflow_type": "string", "restricted_roles": [], "tabs": [ { "id": "", "name": "L", "widget_ids": [ 0 ] } ], "tags": [], "template_variable_presets": [ { "name": "string", "template_variables": [ { "name": "string", "value": "string", "values": [] } ] } ], "template_variables": [ { "available_values": [ "my-host", "host1", "host2" ], "default": "my-host", "defaults": [ "my-host-1", "my-host-2" ], "name": "host1", "prefix": "host", "type": "group" } ], "title": "", "url": "/dashboard/123-abc-456/example-dashboard-title", "widgets": [ { "definition": { "requests": { "fill": { "q": "avg:system.cpu.user{*}" } }, "type": "hostmap" }, "id": "integer", "layout": { "height": 0, "is_column_break": false, "width": 0, "x": 0, "y": 0 } } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Item Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport dashboard_id="CHANGE_ME"\# Curl commandcurl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "layout_type": "ordered", "title": "Example-Dashboard with list_stream widget", "description": "Updated description", "widgets": [ { "definition": { "type": "list_stream", "requests": [ { "columns": [ { "width": "auto", "field": "timestamp" } ], "query": { "data_source": "apm_issue_stream", "query_string": "" }, "response_format": "event_list" } ] } } ] } EOF ##### \# Path parametersexport dashboard_id="CHANGE_ME"\# Curl commandcurl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "layout_type": "ordered", "title": "Example-Dashboard with list_stream widget", "description": "Updated description", "tags": [ "team:foo", "team:bar" ], "widgets": [ { "definition": { "type": "list_stream", "requests": [ { "columns": [ { "width": "auto", "field": "timestamp" } ], "query": { "data_source": "apm_issue_stream", "query_string": "" }, "response_format": "event_list" } ] } } ] } EOF ##### ```go // Update a dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.Dashboard{ LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED, Title: "Example-Dashboard with list_stream widget", Description: *datadog.NewNullableString(datadog.PtrString("Updated description")), Widgets: []datadogV1.Widget{ { Definition: datadogV1.WidgetDefinition{ ListStreamWidgetDefinition: &datadogV1.ListStreamWidgetDefinition{ Type: datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM, Requests: []datadogV1.ListStreamWidgetRequest{ { Columns: []datadogV1.ListStreamColumn{ { Width: datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO, Field: "timestamp", }, }, Query: datadogV1.ListStreamQuery{ DataSource: datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM, QueryString: "", }, ResponseFormat: datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST, }, }, }}, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.UpdateDashboard(ctx, DashboardID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdateDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdateDashboard`:\n%s\n", responseContent) } ``` ##### ```go // Update a dashboard with tags returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.Dashboard{ LayoutType: datadogV1.DASHBOARDLAYOUTTYPE_ORDERED, Title: "Example-Dashboard with list_stream widget", Description: *datadog.NewNullableString(datadog.PtrString("Updated description")), Tags: *datadog.NewNullableList(&[]string{ "team:foo", "team:bar", }), Widgets: []datadogV1.Widget{ { Definition: datadogV1.WidgetDefinition{ ListStreamWidgetDefinition: &datadogV1.ListStreamWidgetDefinition{ Type: datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM, Requests: []datadogV1.ListStreamWidgetRequest{ { Columns: []datadogV1.ListStreamColumn{ { Width: datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO, Field: "timestamp", }, }, Query: datadogV1.ListStreamQuery{ DataSource: datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM, QueryString: "", }, ResponseFormat: datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST, }, }, }}, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.UpdateDashboard(ctx, DashboardID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdateDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdateDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update a dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; import com.datadog.api.client.v1.model.DashboardLayoutType; import com.datadog.api.client.v1.model.ListStreamColumn; import com.datadog.api.client.v1.model.ListStreamColumnWidth; import com.datadog.api.client.v1.model.ListStreamQuery; import com.datadog.api.client.v1.model.ListStreamResponseFormat; import com.datadog.api.client.v1.model.ListStreamSource; import com.datadog.api.client.v1.model.ListStreamWidgetDefinition; import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType; import com.datadog.api.client.v1.model.ListStreamWidgetRequest; import com.datadog.api.client.v1.model.Widget; import com.datadog.api.client.v1.model.WidgetDefinition; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); Dashboard body = new Dashboard() .layoutType(DashboardLayoutType.ORDERED) .title("Example-Dashboard with list_stream widget") .description("Updated description") .widgets( Collections.singletonList( new Widget() .definition( new WidgetDefinition( new ListStreamWidgetDefinition() .type(ListStreamWidgetDefinitionType.LIST_STREAM) .requests( Collections.singletonList( new ListStreamWidgetRequest() .columns( Collections.singletonList( new ListStreamColumn() .width(ListStreamColumnWidth.AUTO) .field("timestamp"))) .query( new ListStreamQuery() .dataSource( ListStreamSource.APM_ISSUE_STREAM) .queryString("")) .responseFormat( ListStreamResponseFormat.EVENT_LIST))))))); try { Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#updateDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Update a dashboard with tags returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.Dashboard; import com.datadog.api.client.v1.model.DashboardLayoutType; import com.datadog.api.client.v1.model.ListStreamColumn; import com.datadog.api.client.v1.model.ListStreamColumnWidth; import com.datadog.api.client.v1.model.ListStreamQuery; import com.datadog.api.client.v1.model.ListStreamResponseFormat; import com.datadog.api.client.v1.model.ListStreamSource; import com.datadog.api.client.v1.model.ListStreamWidgetDefinition; import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType; import com.datadog.api.client.v1.model.ListStreamWidgetRequest; import com.datadog.api.client.v1.model.Widget; import com.datadog.api.client.v1.model.WidgetDefinition; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); Dashboard body = new Dashboard() .layoutType(DashboardLayoutType.ORDERED) .title("Example-Dashboard with list_stream widget") .description("Updated description") .tags(Arrays.asList("team:foo", "team:bar")) .widgets( Collections.singletonList( new Widget() .definition( new WidgetDefinition( new ListStreamWidgetDefinition() .type(ListStreamWidgetDefinitionType.LIST_STREAM) .requests( Collections.singletonList( new ListStreamWidgetRequest() .columns( Collections.singletonList( new ListStreamColumn() .width(ListStreamColumnWidth.AUTO) .field("timestamp"))) .query( new ListStreamQuery() .dataSource( ListStreamSource.APM_ISSUE_STREAM) .queryString("")) .responseFormat( ListStreamResponseFormat.EVENT_LIST))))))); try { Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#updateDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Update a dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard import Dashboard from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType from datadog_api_client.v1.model.list_stream_column import ListStreamColumn from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth from datadog_api_client.v1.model.list_stream_query import ListStreamQuery from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat from datadog_api_client.v1.model.list_stream_source import ListStreamSource from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest from datadog_api_client.v1.model.widget import Widget # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = Dashboard( layout_type=DashboardLayoutType.ORDERED, title="Example-Dashboard with list_stream widget", description="Updated description", widgets=[ Widget( definition=ListStreamWidgetDefinition( type=ListStreamWidgetDefinitionType.LIST_STREAM, requests=[ ListStreamWidgetRequest( columns=[ ListStreamColumn( width=ListStreamColumnWidth.AUTO, field="timestamp", ), ], query=ListStreamQuery( data_source=ListStreamSource.APM_ISSUE_STREAM, query_string="", ), response_format=ListStreamResponseFormat.EVENT_LIST, ), ], ), ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.update_dashboard(dashboard_id=DASHBOARD_ID, body=body) print(response) ``` ##### ```python """ Update a dashboard with tags returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard import Dashboard from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType from datadog_api_client.v1.model.list_stream_column import ListStreamColumn from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth from datadog_api_client.v1.model.list_stream_query import ListStreamQuery from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat from datadog_api_client.v1.model.list_stream_source import ListStreamSource from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest from datadog_api_client.v1.model.widget import Widget # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = Dashboard( layout_type=DashboardLayoutType.ORDERED, title="Example-Dashboard with list_stream widget", description="Updated description", tags=[ "team:foo", "team:bar", ], widgets=[ Widget( definition=ListStreamWidgetDefinition( type=ListStreamWidgetDefinitionType.LIST_STREAM, requests=[ ListStreamWidgetRequest( columns=[ ListStreamColumn( width=ListStreamColumnWidth.AUTO, field="timestamp", ), ], query=ListStreamQuery( data_source=ListStreamSource.APM_ISSUE_STREAM, query_string="", ), response_format=ListStreamResponseFormat.EVENT_LIST, ), ], ), ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.update_dashboard(dashboard_id=DASHBOARD_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update a dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::Dashboard.new({ layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: "Example-Dashboard with list_stream widget", description: "Updated description", widgets: [ DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::ListStreamWidgetDefinition.new({ type: DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM, requests: [ DatadogAPIClient::V1::ListStreamWidgetRequest.new({ columns: [ DatadogAPIClient::V1::ListStreamColumn.new({ width: DatadogAPIClient::V1::ListStreamColumnWidth::AUTO, field: "timestamp", }), ], query: DatadogAPIClient::V1::ListStreamQuery.new({ data_source: DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM, query_string: "", }), response_format: DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST, }), ], }), }), ], }) p api_instance.update_dashboard(DASHBOARD_ID, body) ``` ##### ```ruby # Update a dashboard with tags returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::Dashboard.new({ layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED, title: "Example-Dashboard with list_stream widget", description: "Updated description", tags: [ "team:foo", "team:bar", ], widgets: [ DatadogAPIClient::V1::Widget.new({ definition: DatadogAPIClient::V1::ListStreamWidgetDefinition.new({ type: DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM, requests: [ DatadogAPIClient::V1::ListStreamWidgetRequest.new({ columns: [ DatadogAPIClient::V1::ListStreamColumn.new({ width: DatadogAPIClient::V1::ListStreamColumnWidth::AUTO, field: "timestamp", }), ], query: DatadogAPIClient::V1::ListStreamQuery.new({ data_source: DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM, query_string: "", }), response_format: DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST, }), ], }), }), ], }) p api_instance.update_dashboard(DASHBOARD_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Update a dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::Dashboard; use datadog_api_client::datadogV1::model::DashboardLayoutType; use datadog_api_client::datadogV1::model::ListStreamColumn; use datadog_api_client::datadogV1::model::ListStreamColumnWidth; use datadog_api_client::datadogV1::model::ListStreamQuery; use datadog_api_client::datadogV1::model::ListStreamResponseFormat; use datadog_api_client::datadogV1::model::ListStreamSource; use datadog_api_client::datadogV1::model::ListStreamWidgetDefinition; use datadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType; use datadog_api_client::datadogV1::model::ListStreamWidgetRequest; use datadog_api_client::datadogV1::model::Widget; use datadog_api_client::datadogV1::model::WidgetDefinition; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = Dashboard::new( DashboardLayoutType::ORDERED, "Example-Dashboard with list_stream widget".to_string(), vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition( Box::new(ListStreamWidgetDefinition::new( vec![ListStreamWidgetRequest::new( vec![ListStreamColumn::new( "timestamp".to_string(), ListStreamColumnWidth::AUTO, )], ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM, "".to_string()), ListStreamResponseFormat::EVENT_LIST, )], ListStreamWidgetDefinitionType::LIST_STREAM, )), ))], ) .description(Some("Updated description".to_string())); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.update_dashboard(dashboard_id.clone(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Update a dashboard with tags returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::Dashboard; use datadog_api_client::datadogV1::model::DashboardLayoutType; use datadog_api_client::datadogV1::model::ListStreamColumn; use datadog_api_client::datadogV1::model::ListStreamColumnWidth; use datadog_api_client::datadogV1::model::ListStreamQuery; use datadog_api_client::datadogV1::model::ListStreamResponseFormat; use datadog_api_client::datadogV1::model::ListStreamSource; use datadog_api_client::datadogV1::model::ListStreamWidgetDefinition; use datadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType; use datadog_api_client::datadogV1::model::ListStreamWidgetRequest; use datadog_api_client::datadogV1::model::Widget; use datadog_api_client::datadogV1::model::WidgetDefinition; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = Dashboard::new( DashboardLayoutType::ORDERED, "Example-Dashboard with list_stream widget".to_string(), vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition( Box::new(ListStreamWidgetDefinition::new( vec![ListStreamWidgetRequest::new( vec![ListStreamColumn::new( "timestamp".to_string(), ListStreamColumnWidth::AUTO, )], ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM, "".to_string()), ListStreamResponseFormat::EVENT_LIST, )], ListStreamWidgetDefinitionType::LIST_STREAM, )), ))], ) .description(Some("Updated description".to_string())) .tags(Some(vec!["team:foo".to_string(), "team:bar".to_string()])); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.update_dashboard(dashboard_id.clone(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update a dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiUpdateDashboardRequest = { body: { layoutType: "ordered", title: "Example-Dashboard with list_stream widget", description: "Updated description", widgets: [ { definition: { type: "list_stream", requests: [ { columns: [ { width: "auto", field: "timestamp", }, ], query: { dataSource: "apm_issue_stream", queryString: "", }, responseFormat: "event_list", }, ], }, }, ], }, dashboardId: DASHBOARD_ID, }; apiInstance .updateDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Update a dashboard with tags returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiUpdateDashboardRequest = { body: { layoutType: "ordered", title: "Example-Dashboard with list_stream widget", description: "Updated description", tags: ["team:foo", "team:bar"], widgets: [ { definition: { type: "list_stream", requests: [ { columns: [ { width: "auto", field: "timestamp", }, ], query: { dataSource: "apm_issue_stream", queryString: "", }, responseFormat: "event_list", }, ], }, }, ], }, dashboardId: DASHBOARD_ID, }; apiInstance .updateDashboard(params) .then((data: v1.Dashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Delete a dashboard{% #delete-a-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------- | | ap1.datadoghq.com | DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id} | | ap2.datadoghq.com | DELETE https://api.ap2.datadoghq.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.eu | DELETE https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id} | | app.ddog-gov.com | DELETE https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id} | | app.datadoghq.com | DELETE https://api.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us3.datadoghq.com | DELETE https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id} | | us5.datadoghq.com | DELETE https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id} | ### Overview Delete a dashboard using the specified ID. This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------------ | ------ | ------------------------ | | dashboard_id [*required*] | string | The ID of the dashboard. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response from the delete dashboard call. | Field | Type | Description | | -------------------- | ------ | ---------------------------- | | deleted_dashboard_id | string | ID of the deleted dashboard. | {% /tab %} {% tab title="Example" %} ```json { "deleted_dashboard_id": "string" } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Dashboards Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport dashboard_id="CHANGE_ME"\# Curl commandcurl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Delete a dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.delete_dashboard( dashboard_id=DASHBOARD_ID, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Delete a dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] p api_instance.delete_dashboard(DASHBOARD_ID) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) dashboard_id = '' dog.delete_board(dashboard_id) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Delete a dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.DeleteDashboard(ctx, DashboardID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.DeleteDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Delete a dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardDeleteResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); try { DashboardDeleteResponse result = apiInstance.deleteDashboard(DASHBOARD_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#deleteDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) dashboard_id = '' api.Dashboard.delete(dashboard_id) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ##### ```rust // Delete a dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.delete_dashboard(dashboard_id.clone()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Delete a dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiDeleteDashboardRequest = { dashboardId: DASHBOARD_ID, }; apiInstance .deleteDashboard(params) .then((data: v1.DashboardDeleteResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Delete dashboards{% #delete-dashboards %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------- | | ap1.datadoghq.com | DELETE https://api.ap1.datadoghq.com/api/v1/dashboard | | ap2.datadoghq.com | DELETE https://api.ap2.datadoghq.com/api/v1/dashboard | | app.datadoghq.eu | DELETE https://api.datadoghq.eu/api/v1/dashboard | | app.ddog-gov.com | DELETE https://api.ddog-gov.com/api/v1/dashboard | | app.datadoghq.com | DELETE https://api.datadoghq.com/api/v1/dashboard | | us3.datadoghq.com | DELETE https://api.us3.datadoghq.com/api/v1/dashboard | | us5.datadoghq.com | DELETE https://api.us5.datadoghq.com/api/v1/dashboard | ### Overview Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed). This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Request #### Body Data (required) Delete dashboards request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | --------------------------------------------------------- | | | data [*required*] | [object] | List of dashboard bulk action request data objects. | | data | id [*required*] | string | Dashboard resource ID. | | data | type [*required*] | enum | Dashboard resource type. Allowed enum values: `dashboard` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "id": "123-abc-456", "type": "dashboard" } ] } ``` {% /tab %} ### Response {% tab title="204" %} No Content {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Dashboards Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Curl commandcurl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": [ { "id": "123-abc-456", "type": "dashboard" }, { "id": "789-def-101", "type": "dashboard" } ] } EOF ##### ```go // Delete dashboards returns "No Content" response package main import ( "context" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.DashboardBulkDeleteRequest{ Data: []datadogV1.DashboardBulkActionData{ { Id: DashboardID, Type: datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) r, err := api.DeleteDashboards(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboards`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Delete dashboards returns "No Content" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardBulkActionData; import com.datadog.api.client.v1.model.DashboardBulkDeleteRequest; import com.datadog.api.client.v1.model.DashboardResourceType; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); DashboardBulkDeleteRequest body = new DashboardBulkDeleteRequest() .data( Collections.singletonList( new DashboardBulkActionData() .id(DASHBOARD_ID) .type(DashboardResourceType.DASHBOARD))); try { apiInstance.deleteDashboards(body); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#deleteDashboards"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Delete dashboards returns "No Content" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList from datadog_api_client.v1.model.dashboard_bulk_delete_request import DashboardBulkDeleteRequest from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = DashboardBulkDeleteRequest( data=DashboardBulkActionDataList( [ DashboardBulkActionData( id=DASHBOARD_ID, type=DashboardResourceType.DASHBOARD, ), ] ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) api_instance.delete_dashboards(body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Delete dashboards returns "No Content" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::DashboardBulkDeleteRequest.new({ data: [ DatadogAPIClient::V1::DashboardBulkActionData.new({ id: DASHBOARD_ID, type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD, }), ], }) api_instance.delete_dashboards(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Delete dashboards returns "No Content" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardBulkActionData; use datadog_api_client::datadogV1::model::DashboardBulkDeleteRequest; use datadog_api_client::datadogV1::model::DashboardResourceType; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = DashboardBulkDeleteRequest::new(vec![DashboardBulkActionData::new( dashboard_id.clone(), DashboardResourceType::DASHBOARD, )]); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.delete_dashboards(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Delete dashboards returns "No Content" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiDeleteDashboardsRequest = { body: { data: [ { id: DASHBOARD_ID, type: "dashboard", }, ], }, }; apiInstance .deleteDashboards(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Restore deleted dashboards{% #restore-deleted-dashboards %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v1/dashboard | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v1/dashboard | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v1/dashboard | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v1/dashboard | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v1/dashboard | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v1/dashboard | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v1/dashboard | ### Overview Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed). This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Request #### Body Data (required) Restore dashboards request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | --------------------------------------------------------- | | | data [*required*] | [object] | List of dashboard bulk action request data objects. | | data | id [*required*] | string | Dashboard resource ID. | | data | type [*required*] | enum | Dashboard resource type. Allowed enum values: `dashboard` | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "id": "123-abc-456", "type": "dashboard" } ] } ``` {% /tab %} ### Response {% tab title="204" %} No Content {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Dashboards Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Curl commandcurl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": [ { "id": "123-abc-456", "type": "dashboard" }, { "id": "789-def-101", "type": "dashboard" } ] } EOF ##### ```go // Restore deleted dashboards returns "No Content" response package main import ( "context" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.DashboardRestoreRequest{ Data: []datadogV1.DashboardBulkActionData{ { Id: DashboardID, Type: datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD, }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) r, err := api.RestoreDashboards(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.RestoreDashboards`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Restore deleted dashboards returns "No Content" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardBulkActionData; import com.datadog.api.client.v1.model.DashboardResourceType; import com.datadog.api.client.v1.model.DashboardRestoreRequest; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); DashboardRestoreRequest body = new DashboardRestoreRequest() .data( Collections.singletonList( new DashboardBulkActionData() .id(DASHBOARD_ID) .type(DashboardResourceType.DASHBOARD))); try { apiInstance.restoreDashboards(body); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#restoreDashboards"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Restore deleted dashboards returns "No Content" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType from datadog_api_client.v1.model.dashboard_restore_request import DashboardRestoreRequest # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = DashboardRestoreRequest( data=DashboardBulkActionDataList( [ DashboardBulkActionData( id=DASHBOARD_ID, type=DashboardResourceType.DASHBOARD, ), ] ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) api_instance.restore_dashboards(body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Restore deleted dashboards returns "No Content" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::DashboardRestoreRequest.new({ data: [ DatadogAPIClient::V1::DashboardBulkActionData.new({ id: DASHBOARD_ID, type: DatadogAPIClient::V1::DashboardResourceType::DASHBOARD, }), ], }) api_instance.restore_dashboards(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Restore deleted dashboards returns "No Content" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardBulkActionData; use datadog_api_client::datadogV1::model::DashboardResourceType; use datadog_api_client::datadogV1::model::DashboardRestoreRequest; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = DashboardRestoreRequest::new(vec![DashboardBulkActionData::new( dashboard_id.clone(), DashboardResourceType::DASHBOARD, )]); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.restore_dashboards(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Restore deleted dashboards returns "No Content" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiRestoreDashboardsRequest = { body: { data: [ { id: DASHBOARD_ID, type: "dashboard", }, ], }, }; apiInstance .restoreDashboards(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Create a shared dashboard{% #create-a-shared-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/dashboard/public | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/dashboard/public | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/dashboard/public | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/dashboard/public | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/dashboard/public | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/dashboard/public | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/dashboard/public | ### Overview Share a specified private dashboard, generating a URL at which it can be publicly viewed. This endpoint requires any of the following permissions: `dashboards_public_share``dashboards_embed_share``dashboards_invite_share` OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Request #### Body Data (required) Create a shared dashboard request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------------ | -------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | | author | object | User who shared the dashboard. | | author | handle | string | Identifier of the user who shared the dashboard. | | author | name | string | Name of the user who shared the dashboard. | | | created | date-time | Date the dashboard was shared. | | | dashboard_id [*required*] | string | ID of the dashboard to share. | | | dashboard_type [*required*] | enum | The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard` | | | embeddable_domains | [string] | The `SharedDashboard` `embeddable_domains`. | | | expiration | date-time | The time when an OPEN shared dashboard becomes publicly unavailable. | | | global_time | object | Object containing the live span selection for the dashboard. | | global_time | live_span | enum | Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo` | | | global_time_selectable_enabled | boolean | Whether to allow viewers to select a different global time setting for the shared dashboard. | | | invitees | [object] | The `SharedDashboard` `invitees`. | | invitees | access_expiration | date-time | Time of the invitee expiration. Null means the invite will not expire. | | invitees | created_at | date-time | Time that the invitee was created. | | invitees | email [*required*] | string | Email of the invitee. | | | last_accessed | date-time | The last time the shared dashboard was accessed. Null if never accessed. | | | public_url | string | URL of the shared dashboard. | | | selectable_template_vars | [object] | List of objects representing template variables on the shared dashboard which can have selectable values. | | selectable_template_vars | default_value | string | The default value of the template variable. | | selectable_template_vars | name | string | Name of the template variable. | | selectable_template_vars | prefix | string | The tag/attribute key associated with the template variable. | | selectable_template_vars | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | selectable_template_vars | visible_tags | [string] | List of visible tag values on the shared dashboard. | | | share_list | [string] | **DEPRECATED**: List of email addresses that can receive an invitation to access to the shared dashboard. | | | share_type | enum | Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed` | | | status | enum | Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused` | | | title | string | Title of the shared dashboard. | | | token | string | A unique token assigned to the shared dashboard. | | | viewing_preferences | object | The viewing preferences for a shared dashboard. | | viewing_preferences | high_density | boolean | Whether the widgets on the shared dashboard should be displayed with high density. | | viewing_preferences | theme | enum | The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark` | {% /tab %} {% tab title="Example" %} ##### ```json { "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open", "global_time": { "live_span": "1h" } } ``` ##### ```json { "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open", "global_time": { "live_span": "1h" }, "selectable_template_vars": [ { "default_value": "*", "name": "group_by_var", "type": "group", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ] } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} The metadata object associated with how a dashboard has been/will be shared. | Parent field | Field | Type | Description | | ------------------------ | -------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | | author | object | User who shared the dashboard. | | author | handle | string | Identifier of the user who shared the dashboard. | | author | name | string | Name of the user who shared the dashboard. | | | created | date-time | Date the dashboard was shared. | | | dashboard_id [*required*] | string | ID of the dashboard to share. | | | dashboard_type [*required*] | enum | The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard` | | | embeddable_domains | [string] | The `SharedDashboard` `embeddable_domains`. | | | expiration | date-time | The time when an OPEN shared dashboard becomes publicly unavailable. | | | global_time | object | Object containing the live span selection for the dashboard. | | global_time | live_span | enum | Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo` | | | global_time_selectable_enabled | boolean | Whether to allow viewers to select a different global time setting for the shared dashboard. | | | invitees | [object] | The `SharedDashboard` `invitees`. | | invitees | access_expiration | date-time | Time of the invitee expiration. Null means the invite will not expire. | | invitees | created_at | date-time | Time that the invitee was created. | | invitees | email [*required*] | string | Email of the invitee. | | | last_accessed | date-time | The last time the shared dashboard was accessed. Null if never accessed. | | | public_url | string | URL of the shared dashboard. | | | selectable_template_vars | [object] | List of objects representing template variables on the shared dashboard which can have selectable values. | | selectable_template_vars | default_value | string | The default value of the template variable. | | selectable_template_vars | name | string | Name of the template variable. | | selectable_template_vars | prefix | string | The tag/attribute key associated with the template variable. | | selectable_template_vars | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | selectable_template_vars | visible_tags | [string] | List of visible tag values on the shared dashboard. | | | share_list | [string] | **DEPRECATED**: List of email addresses that can receive an invitation to access to the shared dashboard. | | | share_type | enum | Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed` | | | status | enum | Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused` | | | title | string | Title of the shared dashboard. | | | token | string | A unique token assigned to the shared dashboard. | | | viewing_preferences | object | The viewing preferences for a shared dashboard. | | viewing_preferences | high_density | boolean | Whether the widgets on the shared dashboard should be displayed with high density. | | viewing_preferences | theme | enum | The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark` | {% /tab %} {% tab title="Example" %} ```json { "author": { "handle": "test@datadoghq.com", "name": "string" }, "created": "2019-09-19T10:00:00.000Z", "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "embeddable_domains": [ "https://domain.atlassian.net/", "http://myserver.com/" ], "expiration": "2019-09-19T10:00:00.000Z", "global_time": { "live_span": "1h" }, "global_time_selectable_enabled": false, "invitees": [ { "access_expiration": "2019-09-19T10:00:00.000Z", "created_at": "2019-09-19T10:00:00.000Z", "email": "test@datadoghq.com" } ], "last_accessed": "2019-09-19T10:00:00.000Z", "public_url": "string", "selectable_template_vars": [ { "default_value": "*", "name": "exampleVar", "prefix": "test", "type": "string", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ], "share_list": [ "test@datadoghq.com", "test2@email.com" ], "share_type": "string", "status": "active", "title": "string", "token": "string", "viewing_preferences": { "high_density": false, "theme": "string" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Dashboard Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open" } EOF ##### \## json-request-body # \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open" } EOF ##### ```go // Create a shared dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.SharedDashboard{ DashboardId: DashboardID, DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD, ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()), GlobalTime: &datadogV1.DashboardGlobalTime{ LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.CreatePublicDashboard(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent) } ``` ##### ```go // Create a shared dashboard with a group template variable returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "dashboard" in the system DashboardID := os.Getenv("DASHBOARD_ID") body := datadogV1.SharedDashboard{ DashboardId: DashboardID, DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD, ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()), GlobalTime: &datadogV1.DashboardGlobalTime{ LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(), }, SelectableTemplateVars: []datadogV1.SelectableTemplateVariableItems{ { DefaultValue: datadog.PtrString("*"), Name: datadog.PtrString("group_by_var"), Type: *datadog.NewNullableString(datadog.PtrString("group")), VisibleTags: *datadog.NewNullableList(&[]string{ "selectableValue1", "selectableValue2", }), }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.CreatePublicDashboard(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a shared dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardGlobalTime; import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan; import com.datadog.api.client.v1.model.DashboardShareType; import com.datadog.api.client.v1.model.DashboardType; import com.datadog.api.client.v1.model.SharedDashboard; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); SharedDashboard body = new SharedDashboard() .dashboardId(DASHBOARD_ID) .dashboardType(DashboardType.CUSTOM_TIMEBOARD) .shareType(DashboardShareType.OPEN) .globalTime( new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR)); try { SharedDashboard result = apiInstance.createPublicDashboard(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#createPublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Create a shared dashboard with a group template variable returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardGlobalTime; import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan; import com.datadog.api.client.v1.model.DashboardShareType; import com.datadog.api.client.v1.model.DashboardType; import com.datadog.api.client.v1.model.SelectableTemplateVariableItems; import com.datadog.api.client.v1.model.SharedDashboard; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "dashboard" in the system String DASHBOARD_ID = System.getenv("DASHBOARD_ID"); SharedDashboard body = new SharedDashboard() .dashboardId(DASHBOARD_ID) .dashboardType(DashboardType.CUSTOM_TIMEBOARD) .shareType(DashboardShareType.OPEN) .globalTime( new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR)) .selectableTemplateVars( Collections.singletonList( new SelectableTemplateVariableItems() .defaultValue("*") .name("group_by_var") .type("group") .visibleTags(Arrays.asList("selectableValue1", "selectableValue2")))); try { SharedDashboard result = apiInstance.createPublicDashboard(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#createPublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Create a shared dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_global_time import DashboardGlobalTime from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType from datadog_api_client.v1.model.dashboard_type import DashboardType from datadog_api_client.v1.model.shared_dashboard import SharedDashboard # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = SharedDashboard( dashboard_id=DASHBOARD_ID, dashboard_type=DashboardType.CUSTOM_TIMEBOARD, share_type=DashboardShareType.OPEN, global_time=DashboardGlobalTime( live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.create_public_dashboard(body=body) print(response) ``` ##### ```python """ Create a shared dashboard with a group template variable returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_global_time import DashboardGlobalTime from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType from datadog_api_client.v1.model.dashboard_type import DashboardType from datadog_api_client.v1.model.selectable_template_variable_items import SelectableTemplateVariableItems from datadog_api_client.v1.model.shared_dashboard import SharedDashboard # there is a valid "dashboard" in the system DASHBOARD_ID = environ["DASHBOARD_ID"] body = SharedDashboard( dashboard_id=DASHBOARD_ID, dashboard_type=DashboardType.CUSTOM_TIMEBOARD, share_type=DashboardShareType.OPEN, global_time=DashboardGlobalTime( live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR, ), selectable_template_vars=[ SelectableTemplateVariableItems( default_value="*", name="group_by_var", type="group", visible_tags=[ "selectableValue1", "selectableValue2", ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.create_public_dashboard(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create a shared dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::SharedDashboard.new({ dashboard_id: DASHBOARD_ID, dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD, share_type: DatadogAPIClient::V1::DashboardShareType::OPEN, global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({ live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR, }), }) p api_instance.create_public_dashboard(body) ``` ##### ```ruby # Create a shared dashboard with a group template variable returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "dashboard" in the system DASHBOARD_ID = ENV["DASHBOARD_ID"] body = DatadogAPIClient::V1::SharedDashboard.new({ dashboard_id: DASHBOARD_ID, dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD, share_type: DatadogAPIClient::V1::DashboardShareType::OPEN, global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({ live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR, }), selectable_template_vars: [ DatadogAPIClient::V1::SelectableTemplateVariableItems.new({ default_value: "*", name: "group_by_var", type: "group", visible_tags: [ "selectableValue1", "selectableValue2", ], }), ], }) p api_instance.create_public_dashboard(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create a shared dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardGlobalTime; use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan; use datadog_api_client::datadogV1::model::DashboardShareType; use datadog_api_client::datadogV1::model::DashboardType; use datadog_api_client::datadogV1::model::SharedDashboard; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD) .global_time( DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR), ) .share_type(Some(DashboardShareType::OPEN)); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.create_public_dashboard(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Create a shared dashboard with a group template variable returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardGlobalTime; use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan; use datadog_api_client::datadogV1::model::DashboardShareType; use datadog_api_client::datadogV1::model::DashboardType; use datadog_api_client::datadogV1::model::SelectableTemplateVariableItems; use datadog_api_client::datadogV1::model::SharedDashboard; #[tokio::main] async fn main() { // there is a valid "dashboard" in the system let dashboard_id = std::env::var("DASHBOARD_ID").unwrap(); let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD) .global_time( DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR), ) .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new() .default_value("*".to_string()) .name("group_by_var".to_string()) .type_(Some("group".to_string())) .visible_tags(Some(vec![ "selectableValue1".to_string(), "selectableValue2".to_string(), ]))])) .share_type(Some(DashboardShareType::OPEN)); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.create_public_dashboard(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a shared dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiCreatePublicDashboardRequest = { body: { dashboardId: DASHBOARD_ID, dashboardType: "custom_timeboard", shareType: "open", globalTime: { liveSpan: "1h", }, }, }; apiInstance .createPublicDashboard(params) .then((data: v1.SharedDashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Create a shared dashboard with a group template variable returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "dashboard" in the system const DASHBOARD_ID = process.env.DASHBOARD_ID as string; const params: v1.DashboardsApiCreatePublicDashboardRequest = { body: { dashboardId: DASHBOARD_ID, dashboardType: "custom_timeboard", shareType: "open", globalTime: { liveSpan: "1h", }, selectableTemplateVars: [ { defaultValue: "*", name: "group_by_var", type: "group", visibleTags: ["selectableValue1", "selectableValue2"], }, ], }, }; apiInstance .createPublicDashboard(params) .then((data: v1.SharedDashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get a shared dashboard{% #get-a-shared-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard/public/{token} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard/public/{token} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/dashboard/public/{token} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/dashboard/public/{token} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/dashboard/public/{token} | ### Overview Fetch an existing shared dashboard's sharing metadata associated with the specified token. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ------------------------------------------------------------------------ | | token [*required*] | string | The token of the shared dashboard. Generated when a dashboard is shared. | ### Response {% tab title="200" %} OK {% tab title="Model" %} The metadata object associated with how a dashboard has been/will be shared. | Parent field | Field | Type | Description | | ------------------------ | -------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | | author | object | User who shared the dashboard. | | author | handle | string | Identifier of the user who shared the dashboard. | | author | name | string | Name of the user who shared the dashboard. | | | created | date-time | Date the dashboard was shared. | | | dashboard_id [*required*] | string | ID of the dashboard to share. | | | dashboard_type [*required*] | enum | The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard` | | | embeddable_domains | [string] | The `SharedDashboard` `embeddable_domains`. | | | expiration | date-time | The time when an OPEN shared dashboard becomes publicly unavailable. | | | global_time | object | Object containing the live span selection for the dashboard. | | global_time | live_span | enum | Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo` | | | global_time_selectable_enabled | boolean | Whether to allow viewers to select a different global time setting for the shared dashboard. | | | invitees | [object] | The `SharedDashboard` `invitees`. | | invitees | access_expiration | date-time | Time of the invitee expiration. Null means the invite will not expire. | | invitees | created_at | date-time | Time that the invitee was created. | | invitees | email [*required*] | string | Email of the invitee. | | | last_accessed | date-time | The last time the shared dashboard was accessed. Null if never accessed. | | | public_url | string | URL of the shared dashboard. | | | selectable_template_vars | [object] | List of objects representing template variables on the shared dashboard which can have selectable values. | | selectable_template_vars | default_value | string | The default value of the template variable. | | selectable_template_vars | name | string | Name of the template variable. | | selectable_template_vars | prefix | string | The tag/attribute key associated with the template variable. | | selectable_template_vars | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | selectable_template_vars | visible_tags | [string] | List of visible tag values on the shared dashboard. | | | share_list | [string] | **DEPRECATED**: List of email addresses that can receive an invitation to access to the shared dashboard. | | | share_type | enum | Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed` | | | status | enum | Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused` | | | title | string | Title of the shared dashboard. | | | token | string | A unique token assigned to the shared dashboard. | | | viewing_preferences | object | The viewing preferences for a shared dashboard. | | viewing_preferences | high_density | boolean | Whether the widgets on the shared dashboard should be displayed with high density. | | viewing_preferences | theme | enum | The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark` | {% /tab %} {% tab title="Example" %} ```json { "author": { "handle": "test@datadoghq.com", "name": "string" }, "created": "2019-09-19T10:00:00.000Z", "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "embeddable_domains": [ "https://domain.atlassian.net/", "http://myserver.com/" ], "expiration": "2019-09-19T10:00:00.000Z", "global_time": { "live_span": "1h" }, "global_time_selectable_enabled": false, "invitees": [ { "access_expiration": "2019-09-19T10:00:00.000Z", "created_at": "2019-09-19T10:00:00.000Z", "email": "test@datadoghq.com" } ], "last_accessed": "2019-09-19T10:00:00.000Z", "public_url": "string", "selectable_template_vars": [ { "default_value": "*", "name": "exampleVar", "prefix": "test", "type": "string", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ], "share_list": [ "test@datadoghq.com", "test2@email.com" ], "share_type": "string", "status": "active", "title": "string", "token": "string", "viewing_preferences": { "high_density": false, "theme": "string" } } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Shared Dashboard Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a shared dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.get_public_dashboard( token=SHARED_DASHBOARD_TOKEN, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a shared dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"] p api_instance.get_public_dashboard(SHARED_DASHBOARD_TOKEN) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a shared dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "shared_dashboard" in the system SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.GetPublicDashboard(ctx, SharedDashboardToken) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetPublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetPublicDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a shared dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.SharedDashboard; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "shared_dashboard" in the system String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN"); try { SharedDashboard result = apiInstance.getPublicDashboard(SHARED_DASHBOARD_TOKEN); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#getPublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a shared dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; #[tokio::main] async fn main() { // there is a valid "shared_dashboard" in the system let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap(); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .get_public_dashboard(shared_dashboard_token.clone()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a shared dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "shared_dashboard" in the system const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string; const params: v1.DashboardsApiGetPublicDashboardRequest = { token: SHARED_DASHBOARD_TOKEN, }; apiInstance .getPublicDashboard(params) .then((data: v1.SharedDashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Update a shared dashboard{% #update-a-shared-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v1/dashboard/public/{token} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v1/dashboard/public/{token} | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v1/dashboard/public/{token} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v1/dashboard/public/{token} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v1/dashboard/public/{token} | ### Overview Update a shared dashboard associated with the specified token. This endpoint requires any of the following permissions: `dashboards_public_share``dashboards_embed_share``dashboards_invite_share` OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ---------------------------------- | | token [*required*] | string | The token of the shared dashboard. | ### Request #### Body Data (required) Update Dashboard request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------------------ | ------------------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | | embeddable_domains | [string] | The `SharedDashboard` `embeddable_domains`. | | | expiration | date-time | The time when an OPEN shared dashboard becomes publicly unavailable. | | | global_time | object | Timeframe setting for the shared dashboard. | | global_time | live_span | enum | Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo` | | | global_time_selectable_enabled | boolean | Whether to allow viewers to select a different global time setting for the shared dashboard. | | | invitees | [object] | The `SharedDashboard` `invitees`. | | invitees | access_expiration | date-time | Time of the invitee expiration. Null means the invite will not expire. | | invitees | created_at | date-time | Time that the invitee was created. | | invitees | email [*required*] | string | Email of the invitee. | | | selectable_template_vars | [object] | List of objects representing template variables on the shared dashboard which can have selectable values. | | selectable_template_vars | default_value | string | The default value of the template variable. | | selectable_template_vars | name | string | Name of the template variable. | | selectable_template_vars | prefix | string | The tag/attribute key associated with the template variable. | | selectable_template_vars | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | selectable_template_vars | visible_tags | [string] | List of visible tag values on the shared dashboard. | | | share_list | [string] | **DEPRECATED**: List of email addresses that can be given access to the shared dashboard. | | | share_type | enum | Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed` | | | status | enum | Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused` | | | title | string | Title of the shared dashboard. | | | viewing_preferences | object | The viewing preferences for a shared dashboard. | | viewing_preferences | high_density | boolean | Whether the widgets on the shared dashboard should be displayed with high density. | | viewing_preferences | theme | enum | The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark` | {% /tab %} {% tab title="Example" %} ##### ```json { "global_time": { "live_span": "15m" }, "share_list": [], "share_type": "open" } ``` ##### ```json { "global_time": { "live_span": "15m" }, "share_list": [], "share_type": "open", "selectable_template_vars": [ { "default_value": "*", "name": "group_by_var", "type": "group", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ] } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} The metadata object associated with how a dashboard has been/will be shared. | Parent field | Field | Type | Description | | ------------------------ | -------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | | author | object | User who shared the dashboard. | | author | handle | string | Identifier of the user who shared the dashboard. | | author | name | string | Name of the user who shared the dashboard. | | | created | date-time | Date the dashboard was shared. | | | dashboard_id [*required*] | string | ID of the dashboard to share. | | | dashboard_type [*required*] | enum | The type of the associated private dashboard. Allowed enum values: `custom_timeboard,custom_screenboard` | | | embeddable_domains | [string] | The `SharedDashboard` `embeddable_domains`. | | | expiration | date-time | The time when an OPEN shared dashboard becomes publicly unavailable. | | | global_time | object | Object containing the live span selection for the dashboard. | | global_time | live_span | enum | Dashboard global time live_span selection Allowed enum values: `15m,1h,4h,1d,2d,1w,1mo,3mo` | | | global_time_selectable_enabled | boolean | Whether to allow viewers to select a different global time setting for the shared dashboard. | | | invitees | [object] | The `SharedDashboard` `invitees`. | | invitees | access_expiration | date-time | Time of the invitee expiration. Null means the invite will not expire. | | invitees | created_at | date-time | Time that the invitee was created. | | invitees | email [*required*] | string | Email of the invitee. | | | last_accessed | date-time | The last time the shared dashboard was accessed. Null if never accessed. | | | public_url | string | URL of the shared dashboard. | | | selectable_template_vars | [object] | List of objects representing template variables on the shared dashboard which can have selectable values. | | selectable_template_vars | default_value | string | The default value of the template variable. | | selectable_template_vars | name | string | Name of the template variable. | | selectable_template_vars | prefix | string | The tag/attribute key associated with the template variable. | | selectable_template_vars | type | string | The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by). | | selectable_template_vars | visible_tags | [string] | List of visible tag values on the shared dashboard. | | | share_list | [string] | **DEPRECATED**: List of email addresses that can receive an invitation to access to the shared dashboard. | | | share_type | enum | Type of sharing access (either open to anyone who has the public URL or invite-only). Allowed enum values: `open,invite,embed` | | | status | enum | Active means the dashboard is publicly available. Paused means the dashboard is not publicly available. Allowed enum values: `active,paused` | | | title | string | Title of the shared dashboard. | | | token | string | A unique token assigned to the shared dashboard. | | | viewing_preferences | object | The viewing preferences for a shared dashboard. | | viewing_preferences | high_density | boolean | Whether the widgets on the shared dashboard should be displayed with high density. | | viewing_preferences | theme | enum | The theme of the shared dashboard view. "system" follows your system's default viewing theme. Allowed enum values: `system,light,dark` | {% /tab %} {% tab title="Example" %} ```json { "author": { "handle": "test@datadoghq.com", "name": "string" }, "created": "2019-09-19T10:00:00.000Z", "dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "embeddable_domains": [ "https://domain.atlassian.net/", "http://myserver.com/" ], "expiration": "2019-09-19T10:00:00.000Z", "global_time": { "live_span": "1h" }, "global_time_selectable_enabled": false, "invitees": [ { "access_expiration": "2019-09-19T10:00:00.000Z", "created_at": "2019-09-19T10:00:00.000Z", "email": "test@datadoghq.com" } ], "last_accessed": "2019-09-19T10:00:00.000Z", "public_url": "string", "selectable_template_vars": [ { "default_value": "*", "name": "exampleVar", "prefix": "test", "type": "string", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ], "share_list": [ "test@datadoghq.com", "test2@email.com" ], "share_type": "string", "status": "active", "title": "string", "token": "string", "viewing_preferences": { "high_density": false, "theme": "string" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Item Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "global_time": { "live_span": "1h" }, "selectable_template_vars": [ { "default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ], "share_list": [ "test@datadoghq.com", "test2@datadoghq.com" ], "share_type": "invite" } EOF ##### \## json-request-body # \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "global_time": { "live_span": "1h" }, "selectable_template_vars": [ { "default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": [ "selectableValue1", "selectableValue2" ] } ], "share_list": [ "test@datadoghq.com", "test2@datadoghq.com" ], "share_type": "invite" } EOF ##### ```go // Update a shared dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "shared_dashboard" in the system SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN") body := datadogV1.SharedDashboardUpdateRequest{ GlobalTime: *datadogV1.NewNullableSharedDashboardUpdateRequestGlobalTime(&datadogV1.SharedDashboardUpdateRequestGlobalTime{ LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_FIFTEEN_MINUTES.Ptr(), }), ShareList: *datadog.NewNullableList(&[]string{}), ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()), } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.UpdatePublicDashboard(ctx, SharedDashboardToken, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdatePublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdatePublicDashboard`:\n%s\n", responseContent) } ``` ##### ```go // Update a shared dashboard with selectable_template_vars returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "shared_dashboard" in the system SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN") body := datadogV1.SharedDashboardUpdateRequest{ GlobalTime: *datadogV1.NewNullableSharedDashboardUpdateRequestGlobalTime(&datadogV1.SharedDashboardUpdateRequestGlobalTime{ LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_FIFTEEN_MINUTES.Ptr(), }), ShareList: *datadog.NewNullableList(&[]string{}), ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()), SelectableTemplateVars: []datadogV1.SelectableTemplateVariableItems{ { DefaultValue: datadog.PtrString("*"), Name: datadog.PtrString("group_by_var"), Type: *datadog.NewNullableString(datadog.PtrString("group")), VisibleTags: *datadog.NewNullableList(&[]string{ "selectableValue1", "selectableValue2", }), }, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.UpdatePublicDashboard(ctx, SharedDashboardToken, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.UpdatePublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.UpdatePublicDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update a shared dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan; import com.datadog.api.client.v1.model.DashboardShareType; import com.datadog.api.client.v1.model.SharedDashboard; import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest; import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "shared_dashboard" in the system String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN"); SharedDashboardUpdateRequest body = new SharedDashboardUpdateRequest() .globalTime( new SharedDashboardUpdateRequestGlobalTime() .liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES)) .shareType(DashboardShareType.OPEN); try { SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#updatePublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ##### ```java // Update a shared dashboard with selectable_template_vars returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan; import com.datadog.api.client.v1.model.DashboardShareType; import com.datadog.api.client.v1.model.SelectableTemplateVariableItems; import com.datadog.api.client.v1.model.SharedDashboard; import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest; import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "shared_dashboard" in the system String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN"); SharedDashboardUpdateRequest body = new SharedDashboardUpdateRequest() .globalTime( new SharedDashboardUpdateRequestGlobalTime() .liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES)) .shareType(DashboardShareType.OPEN) .selectableTemplateVars( Collections.singletonList( new SelectableTemplateVariableItems() .defaultValue("*") .name("group_by_var") .type("group") .visibleTags(Arrays.asList("selectableValue1", "selectableValue2")))); try { SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#updatePublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Update a shared dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType from datadog_api_client.v1.model.shared_dashboard_update_request import SharedDashboardUpdateRequest from datadog_api_client.v1.model.shared_dashboard_update_request_global_time import ( SharedDashboardUpdateRequestGlobalTime, ) # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"] body = SharedDashboardUpdateRequest( global_time=SharedDashboardUpdateRequestGlobalTime( live_span=DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES, ), share_list=[], share_type=DashboardShareType.OPEN, ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.update_public_dashboard(token=SHARED_DASHBOARD_TOKEN, body=body) print(response) ``` ##### ```python """ Update a shared dashboard with selectable_template_vars returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType from datadog_api_client.v1.model.selectable_template_variable_items import SelectableTemplateVariableItems from datadog_api_client.v1.model.shared_dashboard_update_request import SharedDashboardUpdateRequest from datadog_api_client.v1.model.shared_dashboard_update_request_global_time import ( SharedDashboardUpdateRequestGlobalTime, ) # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"] body = SharedDashboardUpdateRequest( global_time=SharedDashboardUpdateRequestGlobalTime( live_span=DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES, ), share_list=[], share_type=DashboardShareType.OPEN, selectable_template_vars=[ SelectableTemplateVariableItems( default_value="*", name="group_by_var", type="group", visible_tags=[ "selectableValue1", "selectableValue2", ], ), ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.update_public_dashboard(token=SHARED_DASHBOARD_TOKEN, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update a shared dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"] body = DatadogAPIClient::V1::SharedDashboardUpdateRequest.new({ global_time: DatadogAPIClient::V1::SharedDashboardUpdateRequestGlobalTime.new({ live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES, }), share_list: [], share_type: DatadogAPIClient::V1::DashboardShareType::OPEN, }) p api_instance.update_public_dashboard(SHARED_DASHBOARD_TOKEN, body) ``` ##### ```ruby # Update a shared dashboard with selectable_template_vars returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"] body = DatadogAPIClient::V1::SharedDashboardUpdateRequest.new({ global_time: DatadogAPIClient::V1::SharedDashboardUpdateRequestGlobalTime.new({ live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES, }), share_list: [], share_type: DatadogAPIClient::V1::DashboardShareType::OPEN, selectable_template_vars: [ DatadogAPIClient::V1::SelectableTemplateVariableItems.new({ default_value: "*", name: "group_by_var", type: "group", visible_tags: [ "selectableValue1", "selectableValue2", ], }), ], }) p api_instance.update_public_dashboard(SHARED_DASHBOARD_TOKEN, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Update a shared dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan; use datadog_api_client::datadogV1::model::DashboardShareType; use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequest; use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequestGlobalTime; #[tokio::main] async fn main() { // there is a valid "shared_dashboard" in the system let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap(); let body = SharedDashboardUpdateRequest::new() .global_time(Some( SharedDashboardUpdateRequestGlobalTime::new() .live_span(DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES), )) .share_list(Some(vec![])) .share_type(Some(DashboardShareType::OPEN)); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .update_public_dashboard(shared_dashboard_token.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` ##### ```rust // Update a shared dashboard with selectable_template_vars returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan; use datadog_api_client::datadogV1::model::DashboardShareType; use datadog_api_client::datadogV1::model::SelectableTemplateVariableItems; use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequest; use datadog_api_client::datadogV1::model::SharedDashboardUpdateRequestGlobalTime; #[tokio::main] async fn main() { // there is a valid "shared_dashboard" in the system let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap(); let body = SharedDashboardUpdateRequest::new() .global_time(Some( SharedDashboardUpdateRequestGlobalTime::new() .live_span(DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES), )) .selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new() .default_value("*".to_string()) .name("group_by_var".to_string()) .type_(Some("group".to_string())) .visible_tags(Some(vec![ "selectableValue1".to_string(), "selectableValue2".to_string(), ]))])) .share_list(Some(vec![])) .share_type(Some(DashboardShareType::OPEN)); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .update_public_dashboard(shared_dashboard_token.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update a shared dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "shared_dashboard" in the system const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string; const params: v1.DashboardsApiUpdatePublicDashboardRequest = { body: { globalTime: { liveSpan: "15m", }, shareList: [], shareType: "open", }, token: SHARED_DASHBOARD_TOKEN, }; apiInstance .updatePublicDashboard(params) .then((data: v1.SharedDashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` ##### ```typescript /** * Update a shared dashboard with selectable_template_vars returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "shared_dashboard" in the system const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string; const params: v1.DashboardsApiUpdatePublicDashboardRequest = { body: { globalTime: { liveSpan: "15m", }, shareList: [], shareType: "open", selectableTemplateVars: [ { defaultValue: "*", name: "group_by_var", type: "group", visibleTags: ["selectableValue1", "selectableValue2"], }, ], }, token: SHARED_DASHBOARD_TOKEN, }; apiInstance .updatePublicDashboard(params) .then((data: v1.SharedDashboard) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Send shared dashboard invitation email{% #send-shared-dashboard-invitation-email %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitation | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation | ### Overview Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list. This endpoint requires the `dashboards_invite_share` permission. OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ---------------------------------- | | token [*required*] | string | The token of the shared dashboard. | ### Request #### Body Data (required) Shared Dashboard Invitation request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | | An object or list of objects containing the information for an invitation to a shared dashboard. | | data | Option 1 | object | Object containing the information for an invitation to a shared dashboard. | | Option 1 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 1 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | data | Option 2 | [object] | A list of objects containing the information for an invitation(s) to a shared dashboard. | | Option 2 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 2 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | | meta | object | Pagination metadata returned by the API. | | meta | page | object | Object containing the total count of invitations across all pages | | page | total_count | int64 | The total number of invitations on this shared board, across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "email": "exampledashboard@datadoghq.com" }, "type": "public_dashboard_invitation" } } ``` {% /tab %} ### Response {% tab title="201" %} OK {% tab title="Model" %} Invitations data and metadata that exists for a shared dashboard returned by the API. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | | An object or list of objects containing the information for an invitation to a shared dashboard. | | data | Option 1 | object | Object containing the information for an invitation to a shared dashboard. | | Option 1 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 1 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | data | Option 2 | [object] | A list of objects containing the information for an invitation(s) to a shared dashboard. | | Option 2 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 2 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | | meta | object | Pagination metadata returned by the API. | | meta | page | object | Object containing the total count of invitations across all pages | | page | total_count | int64 | The total number of invitations on this shared board, across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "email": "test@datadoghq.com" }, "type": "public_dashboard_invitation" } ] } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": [ { "attributes": { "email": "test@datadoghq.com" }, "type": "public_dashboard_invitation" } ] } EOF {% /tab %} ## Get all invitations for a shared dashboard{% #get-all-invitations-for-a-shared-dashboard %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitation | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation | ### Overview Describe the invitations that exist for the given shared dashboard (paginated). This endpoint requires the `dashboards_invite_share` permission. OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ------------------------------------------------------------- | | token [*required*] | string | Token of the shared dashboard for which to fetch invitations. | #### Query Strings | Name | Type | Description | | ----------- | ------- | ---------------------------------------------------- | | page_size | integer | The number of records to return in a single request. | | page_number | integer | The page to access (base 0). | ### Response {% tab title="200" %} OK {% tab title="Model" %} Invitations data and metadata that exists for a shared dashboard returned by the API. | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | | An object or list of objects containing the information for an invitation to a shared dashboard. | | data | Option 1 | object | Object containing the information for an invitation to a shared dashboard. | | Option 1 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 1 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | data | Option 2 | [object] | A list of objects containing the information for an invitation(s) to a shared dashboard. | | Option 2 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 2 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | | meta | object | Pagination metadata returned by the API. | | meta | page | object | Object containing the total count of invitations across all pages | | page | total_count | int64 | The total number of invitations on this shared board, across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": [ { "attributes": { "email": "test@datadoghq.com" }, "type": "public_dashboard_invitation" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all invitations for a shared dashboard returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = environ["SHARED_DASHBOARD_TOKEN"] configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.get_public_dashboard_invitations( token=SHARED_DASHBOARD_TOKEN, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get all invitations for a shared dashboard returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new # there is a valid "shared_dashboard" in the system SHARED_DASHBOARD_TOKEN = ENV["SHARED_DASHBOARD_TOKEN"] p api_instance.get_public_dashboard_invitations(SHARED_DASHBOARD_TOKEN) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get all invitations for a shared dashboard returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { // there is a valid "shared_dashboard" in the system SharedDashboardToken := os.Getenv("SHARED_DASHBOARD_TOKEN") ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.GetPublicDashboardInvitations(ctx, SharedDashboardToken, *datadogV1.NewGetPublicDashboardInvitationsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.GetPublicDashboardInvitations`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.GetPublicDashboardInvitations`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get all invitations for a shared dashboard returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.SharedDashboardInvites; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); // there is a valid "shared_dashboard" in the system String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN"); try { SharedDashboardInvites result = apiInstance.getPublicDashboardInvitations(SHARED_DASHBOARD_TOKEN); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#getPublicDashboardInvitations"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get all invitations for a shared dashboard returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::api_dashboards::GetPublicDashboardInvitationsOptionalParams; #[tokio::main] async fn main() { // there is a valid "shared_dashboard" in the system let shared_dashboard_token = std::env::var("SHARED_DASHBOARD_TOKEN").unwrap(); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .get_public_dashboard_invitations( shared_dashboard_token.clone(), GetPublicDashboardInvitationsOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get all invitations for a shared dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); // there is a valid "shared_dashboard" in the system const SHARED_DASHBOARD_TOKEN = process.env.SHARED_DASHBOARD_TOKEN as string; const params: v1.DashboardsApiGetPublicDashboardInvitationsRequest = { token: SHARED_DASHBOARD_TOKEN, }; apiInstance .getPublicDashboardInvitations(params) .then((data: v1.SharedDashboardInvites) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Revoke a shared dashboard URL{% #revoke-a-shared-dashboard-url %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------- | | ap1.datadoghq.com | DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token} | | ap2.datadoghq.com | DELETE https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token} | | app.datadoghq.eu | DELETE https://api.datadoghq.eu/api/v1/dashboard/public/{token} | | app.ddog-gov.com | DELETE https://api.ddog-gov.com/api/v1/dashboard/public/{token} | | app.datadoghq.com | DELETE https://api.datadoghq.com/api/v1/dashboard/public/{token} | | us3.datadoghq.com | DELETE https://api.us3.datadoghq.com/api/v1/dashboard/public/{token} | | us5.datadoghq.com | DELETE https://api.us5.datadoghq.com/api/v1/dashboard/public/{token} | ### Overview Revoke the public URL for a dashboard (rendering it private) associated with the specified token. This endpoint requires any of the following permissions: `dashboards_public_share``dashboards_embed_share``dashboards_invite_share` OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ---------------------------------- | | token [*required*] | string | The token of the shared dashboard. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing token of deleted shared dashboard. | Field | Type | Description | | ------------------------------ | ------ | ------------------------------------------------------------ | | deleted_public_dashboard_token | string | Token associated with the shared dashboard that was revoked. | {% /tab %} {% tab title="Example" %} ```json { "deleted_public_dashboard_token": "string" } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Shared Dashboard Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Revoke a shared dashboard URL returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.delete_public_dashboard( token="token", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Revoke a shared dashboard URL returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new p api_instance.delete_public_dashboard("token") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Revoke a shared dashboard URL returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.DeletePublicDashboard(ctx, "token") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeletePublicDashboard`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.DeletePublicDashboard`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Revoke a shared dashboard URL returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DeleteSharedDashboardResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); try { DeleteSharedDashboardResponse result = apiInstance.deletePublicDashboard("token"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#deletePublicDashboard"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Revoke a shared dashboard URL returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api.delete_public_dashboard("token".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Revoke a shared dashboard URL returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiDeletePublicDashboardRequest = { token: "token", }; apiInstance .deletePublicDashboard(params) .then((data: v1.DeleteSharedDashboardResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Revoke shared dashboard invitations{% #revoke-shared-dashboard-invitations %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------- | | ap1.datadoghq.com | DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | ap2.datadoghq.com | DELETE https://api.ap2.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.eu | DELETE https://api.datadoghq.eu/api/v1/dashboard/public/{token}/invitation | | app.ddog-gov.com | DELETE https://api.ddog-gov.com/api/v1/dashboard/public/{token}/invitation | | app.datadoghq.com | DELETE https://api.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us3.datadoghq.com | DELETE https://api.us3.datadoghq.com/api/v1/dashboard/public/{token}/invitation | | us5.datadoghq.com | DELETE https://api.us5.datadoghq.com/api/v1/dashboard/public/{token}/invitation | ### Overview Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses. This endpoint requires the `dashboards_invite_share` permission. OAuth apps require the `dashboards_invite_share` authorization [scope](https://docs.datadoghq.com/api/latest/scopes/#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------- | ------ | ---------------------------------- | | token [*required*] | string | The token of the shared dashboard. | ### Request #### Body Data (required) Shared Dashboard Invitation deletion request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------ | | | data [*required*] | | An object or list of objects containing the information for an invitation to a shared dashboard. | | data | Option 1 | object | Object containing the information for an invitation to a shared dashboard. | | Option 1 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 1 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | data | Option 2 | [object] | A list of objects containing the information for an invitation(s) to a shared dashboard. | | Option 2 | attributes [*required*] | object | Attributes of the shared dashboard invitation | | attributes | created_at | date-time | When the invitation was sent. | | attributes | email | string | An email address that an invitation has been (or if used in invitation request, will be) sent to. | | attributes | has_session | boolean | Indicates whether an active session exists for the invitation (produced when a user clicks the link in the email). | | attributes | invitation_expiry | date-time | When the invitation expires. | | attributes | session_expiry | date-time | When the invited user's session expires. null if the invitation has no associated session. | | attributes | share_token | string | The unique token of the shared dashboard that was (or is to be) shared. | | Option 2 | type [*required*] | enum | Type for shared dashboard invitation request body. Allowed enum values: `public_dashboard_invitation` | | | meta | object | Pagination metadata returned by the API. | | meta | page | object | Object containing the total count of invitations across all pages | | page | total_count | int64 | The total number of invitations on this shared board, across all pages. | {% /tab %} {% tab title="Example" %} ```json { "data": [ "undefined" ] } ``` {% /tab %} ### Response {% tab title="204" %} OK {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## json-request-body # \# Path parametersexport token="CHANGE_ME"\# Curl commandcurl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/public/${token}/invitation" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "email": "test@datadoghq.com" }, "type": "public_dashboard_invitation" } } EOF ##### ```python """ Revoke shared dashboard invitations returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi from datadog_api_client.v1.model.dashboard_invite_type import DashboardInviteType from datadog_api_client.v1.model.shared_dashboard_invites import SharedDashboardInvites from datadog_api_client.v1.model.shared_dashboard_invites_data_list import SharedDashboardInvitesDataList from datadog_api_client.v1.model.shared_dashboard_invites_data_object import SharedDashboardInvitesDataObject from datadog_api_client.v1.model.shared_dashboard_invites_data_object_attributes import ( SharedDashboardInvitesDataObjectAttributes, ) body = SharedDashboardInvites( data=SharedDashboardInvitesDataList( [ SharedDashboardInvitesDataObject( attributes=SharedDashboardInvitesDataObjectAttributes( email="test@datadoghq.com", ), type=DashboardInviteType.PUBLIC_DASHBOARD_INVITATION, ), ] ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) api_instance.delete_public_dashboard_invitation(token="token", body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Revoke shared dashboard invitations returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new body = DatadogAPIClient::V1::SharedDashboardInvites.new({ data: [ DatadogAPIClient::V1::SharedDashboardInvitesDataObject.new({ attributes: DatadogAPIClient::V1::SharedDashboardInvitesDataObjectAttributes.new({ email: "test@datadoghq.com", }), type: DatadogAPIClient::V1::DashboardInviteType::PUBLIC_DASHBOARD_INVITATION, }), ], }) api_instance.delete_public_dashboard_invitation("token", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Revoke shared dashboard invitations returns "OK" response package main import ( "context" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { body := datadogV1.SharedDashboardInvites{ Data: datadogV1.SharedDashboardInvitesData{ SharedDashboardInvitesDataList: &[]datadogV1.SharedDashboardInvitesDataObject{ { Attributes: datadogV1.SharedDashboardInvitesDataObjectAttributes{ Email: datadog.PtrString("test@datadoghq.com"), }, Type: datadogV1.DASHBOARDINVITETYPE_PUBLIC_DASHBOARD_INVITATION, }, }}, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) r, err := api.DeletePublicDashboardInvitation(ctx, "token", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeletePublicDashboardInvitation`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Revoke shared dashboard invitations returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.model.DashboardInviteType; import com.datadog.api.client.v1.model.SharedDashboardInvites; import com.datadog.api.client.v1.model.SharedDashboardInvitesData; import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObject; import com.datadog.api.client.v1.model.SharedDashboardInvitesDataObjectAttributes; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); SharedDashboardInvites body = new SharedDashboardInvites() .data( new SharedDashboardInvitesData( Collections.singletonList( new SharedDashboardInvitesDataObject() .attributes( new SharedDashboardInvitesDataObjectAttributes() .email("test@datadoghq.com")) .type(DashboardInviteType.PUBLIC_DASHBOARD_INVITATION)))); try { apiInstance.deletePublicDashboardInvitation("token", body); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#deletePublicDashboardInvitation"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Revoke shared dashboard invitations returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::model::DashboardInviteType; use datadog_api_client::datadogV1::model::SharedDashboardInvites; use datadog_api_client::datadogV1::model::SharedDashboardInvitesData; use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObject; use datadog_api_client::datadogV1::model::SharedDashboardInvitesDataObjectAttributes; #[tokio::main] async fn main() { let body = SharedDashboardInvites::new(SharedDashboardInvitesData::SharedDashboardInvitesDataList( vec![SharedDashboardInvitesDataObject::new( SharedDashboardInvitesDataObjectAttributes::new() .email("test@datadoghq.com".to_string()), DashboardInviteType::PUBLIC_DASHBOARD_INVITATION, )], )); let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .delete_public_dashboard_invitation("token".to_string(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Revoke shared dashboard invitations returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiDeletePublicDashboardInvitationRequest = { body: { data: [ { attributes: { email: "test@datadoghq.com", }, type: "public_dashboard_invitation", }, ], }, token: "token", }; apiInstance .deletePublicDashboardInvitation(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest/?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}