--- title: ダッシュボードを取得する description: 指定された ID を使用してダッシュボードを取得します。 breadcrumbs: ドキュメント > API > ダッシュボードを取得する --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # ダッシュボードを取得する ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------- | | 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} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id} | | 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} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/dashboard/{dashboard_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/dashboard/{dashboard_id} | ### Overview 指定された ID を使用してダッシュボードを取得します。 This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ja/api/latest/scopes.md#dashboards) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------- | ------ | ------------------------ | | dashboard_id [*required*] | string | The ID of the dashboard. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="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. Read-only. | | | author_name | string | Name of the dashboard author. Read-only. | | | created_at | date-time | Creation date of the dashboard. Read-only. | | | default_timeframe | | The default timeframe applied when opening the dashboard. Set to `null` to clear. | | default_timeframe | | object | A live dashboard timeframe. | | | type [*required*] | enum | Type of live timeframe. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the live timeframe span. | | default_timeframe | | object | A fixed dashboard timeframe. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type of fixed timeframe. Allowed enum values: `fixed`. | | | description | string | Description of the dashboard. | | | experience_type | enum | The experience type of the dashboard. Read-only. Allowed enum values: `default`, `product_analytics`. | | | id | string | ID of the dashboard. Read-only. | | | 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.md) 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. Read-only. | | | 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. Read-only. | | | widgets [*required*] | [object] | List of widgets to display on the dashboard. | | widgets | definition [*required*] | | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets.md). | | definition | | object | Alert graphs are timeseries graphs showing the current status of any monitor defined on your system. | | | alert_id [*required*] | string | ID of the alert to use in the widget. | | | description | string | The description of the widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | The title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the alert graph widget. Allowed enum values: `alert_graph`. Default: `alert_graph`. | | | viz_type [*required*] | enum | Whether to display the Alert Graph as a timeseries or a top list. Allowed enum values: `timeseries`, `toplist`. | | definition | | object | Alert values are query values showing the current value of the metric in any monitor defined on your system. | | | alert_id [*required*] | string | ID of the alert to use in the widget. | | | description | string | The description of the widget. | | | precision | int64 | Number of decimal to show. If not defined, will use the raw value. | | | text_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of value in the widget. | | | type [*required*] | enum | Type of the alert value widget. Allowed enum values: `alert_value`. Default: `alert_value`. | | | unit | string | Unit to display with the value. | | definition | | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | | 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`. | | | description | string | The description of the widget. | | | 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | | object | Bar chart widget stacked display options. | | | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic`, `inline`, `none`. | | | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked`. Default: `stacked`. | | display | | object | Bar chart widget flat display. | | | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat`. Default: `flat`. | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute`, `relative`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart`. Default: `bar_chart`. | | definition | | object | The Change graph shows you the change in a value over the time period chosen. | | | 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`. | | | description | string | The description of the widget. | | | 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.md) 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the change widget. Allowed enum values: `change`. Default: `change`. | | definition | | object | Check status shows the current status or number of results for any check performed. | | | check [*required*] | string | Name of the check to use in the widget. | | | description | string | The description of the widget. | | | group | string | Group reporting a single check. | | | group_by | [string] | List of tag prefixes to group by in the case of a cluster check. | | | grouping [*required*] | enum | The kind of grouping to use. Allowed enum values: `check`, `cluster`. | | | tags | [string] | List of tags used to filter the groups reporting a cluster check. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the check status widget. Allowed enum values: `check_status`. Default: `check_status`. | | definition | | object | The cohort widget visualizes user retention over time. | | | description | string | The description of the widget. | | | requests [*required*] | [object] | List of Cohort widget requests. | | requests | query [*required*] | object | Retention query definition. | | query | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | query | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | query | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | query | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | query | name | string | Name of the query. | | query | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | requests | request_type [*required*] | enum | Request type for retention grid widget. Allowed enum values: `retention_grid`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the Cohort widget. Allowed enum values: `cohort`. Default: `cohort`. | | definition | | 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. | | | 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`. | | | description | string | The description of the widget. | | | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | | markers | [object] | List of markers. | | markers | display_type | string | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. | | 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). | | | 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.md) 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | requests | query | | Query definition for Distribution Widget Histogram Request | | query | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | query | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | 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.md#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.md#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. | | | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution`. Default: `distribution`. | | | 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. Default: `auto`. | | 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. Default: `auto`. | | 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`. Default: `linear`. | | | 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. Default: `auto`. | | yaxis | min | string | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear` or `log`. Default: `linear`. | | definition | | object | The embedded app widget displays an App Builder app on a dashboard. Exactly one of `app_id` or `template_id` must be provided; they cannot be provided together. | | | app_id | string | UUID of the App Builder app to embed. | | | 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`. | | | description | string | The description of the widget. | | | inputs | [object] | Inputs passed to the embedded app. | | inputs | name [*required*] | string | Name of the app input. | | inputs | value [*required*] | any | Value of the app input. The API accepts a string, number, boolean, object, or a non-empty homogeneous array of those types. | | | template_id | string | ID of the built-in app template to embed. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the embedded app widget. Allowed enum values: `embedded_app`. Default: `embedded_app`. | | definition | | object | The event stream is a widget version of the stream of events on the Event Stream view. Only available on FREE layout dashboards. | | | description | string | The description of the widget. | | | event_size | enum | Size to use to display an event. Allowed enum values: `s`, `l`. | | | query [*required*] | string | Query to filter the event stream with. | | | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the event stream widget. Allowed enum values: `event_stream`. Default: `event_stream`. | | definition | | 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. | | | description | string | The description of the widget. | | | query [*required*] | string | Query to filter the event timeline with. | | | tags_execution | string | The execution method for multi-value filters. Can be either and or or. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the event timeline widget. Allowed enum values: `event_timeline`. Default: `event_timeline`. | | definition | | 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. | | | background_color | string | Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`. | | | color | string | Color of the text. | | | font_size | string | Size of the text. | | | text [*required*] | string | Text to display. | | | text_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | type [*required*] | enum | Type of the free text widget. Allowed enum values: `free_text`. Default: `free_text`. | | definition | Object 12 | object | The funnel visualization displays a funnel of user sessions that maps a sequence of view navigation and user interaction in your application. | | Object 12 | description | string | The description of the widget. | | Object 12 | grouped_display | enum | Display mode for grouped funnel results. Allowed enum values: `stacked`, `side_by_side`. | | Object 12 | 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`. Default: `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`. | | Object 12 | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | Object 12 | title | string | The title of the widget. | | Object 12 | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | Object 12 | title_size | string | The size of the title. | | Object 12 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel`. Default: `funnel`. | | definition | Object 13 | object | The user journey funnel visualization displays conversion funnels based on user journey data from Product Analytics. | | Object 13 | description | string | The description of the widget. | | Object 13 | grouped_display | enum | Display mode for grouped funnel results. Allowed enum values: `stacked`, `side_by_side`. | | Object 13 | requests [*required*] | [object] | Request payload used to query items. | | requests | comparison_segments | [string] | Comparison segments. | | requests | comparison_time | object | Comparison time configuration for funnel widgets. | | comparison_time | custom_timeframe | object | Custom timeframe for funnel comparison. | | custom_timeframe | from [*required*] | double | Start of the custom timeframe. | | custom_timeframe | to [*required*] | double | End of the custom timeframe. | | comparison_time | type [*required*] | enum | Type of comparison duration. Allowed enum values: `previous_timeframe`, `custom_timeframe`, `previous_day`, `previous_week`, `previous_month`. | | requests | query [*required*] | object | User journey funnel query definition. | | query | compute | object | Compute configuration for user journey funnel. | | compute | aggregation [*required*] | enum | Aggregation type for user journey funnel compute. Allowed enum values: `cardinality`, `count`. | | compute | metric [*required*] | enum | Metric for user journey funnel compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` (unique users/sessions) and `cardinality` (total users/sessions) as aggregations. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`. | | query | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | query | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for user journey funnel group by. | | sort | aggregation [*required*] | string | Aggregation type. | | sort | metric | string | Metric to sort by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | query | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | query | subquery_id | string | Subquery ID. | | requests | request_type [*required*] | enum | Request type for user journey funnel widget. Allowed enum values: `user_journey_funnel`. | | Object 13 | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | Object 13 | title | string | The title of the widget. | | Object 13 | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | Object 13 | title_size | string | The size of the title. | | Object 13 | type [*required*] | enum | Type of funnel widget. Allowed enum values: `funnel`. Default: `funnel`. | | definition | | object | This visualization displays a series of values by country on a world map. | | | 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`. | | | description | string | The description of the widget. | | | 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.md) 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | requests | query | object | Updated list stream widget. | | query | assignee_uuids | [string] | Filter by assignee UUIDs. Usable only with `issue_stream`. | | 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`, `max`, `avg`, `earliest`, `latest`, `most_frequent`. | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. 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`, `event_stream`, `rum_stream`, `llm_observability_stream`, `issue_stream`, `security_runtime_stream`, `security_signals_stream`, `incidents_stream`, `case_stream`. Default: `logs_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 | persona | enum | Persona filter for the `issue_stream` data source. Allowed enum values: `all`, `browser`, `mobile`, `backend`. | | 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 | states | [string] | Filter by issue states. Usable only with `issue_stream`. | | query | storage | string | Option for storage location. Feature in Private Beta. | | query | suspected_causes | [string] | Filter by suspected causes. Usable only with `issue_stream`. | | query | team_handles | [string] | Filter by team handles. Usable only with `issue_stream`. | | query | version | enum | Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** Allowed enum values: `sequential_query`. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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`, `custom_text`. Default: `white_on_green`. | | text_formats | replace | | Replace rule for the table widget text format. | | replace | | object | Match All definition. | | | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all`. | | | with [*required*] | string | Replace All type. | | replace | | object | Match Sub-string definition. | | | substring [*required*] | string | Text that will be replaced. | | | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring`. | | | with [*required*] | string | Text that will replace original sub-string. | | | 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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | The title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | The size of the title. | | | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap`. Default: `geomap`. | | | 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 | | 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. | | | background_color | string | Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`. | | | banner_img | string | URL of image to display as a banner for the group. | | | layout_type [*required*] | enum | Layout type of the group. Allowed enum values: `ordered`. | | | show_title | boolean | Whether to show the title or not. Default: `true`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | type [*required*] | enum | Type of the group widget. Allowed enum values: `group`. Default: `group`. | | | widgets [*required*] | [object] | List of widget groups. | | definition | | object | The heatgrid visualization displays values for each group over time using color. | | | color | | Color configuration for continuous gradients or discrete thresholds. | | color | Object 1 | object | A continuous gradient with custom color stops. | | Object 1 | mode [*required*] | enum | Use a continuous color gradient. Allowed enum values: `gradient`. | | Object 1 | source [*required*] | enum | Use custom colors. Allowed enum values: `custom`. | | Object 1 | stops [*required*] | [object] | Two to six stops with positions in ascending order. | | stops | color [*required*] | | A color string, or two color strings for the light and dark themes, in that order. | | color | Object 1 | string | | | color | Object 2 | [string] | Two color strings for the light and dark themes, in that order. | | stops | position [*required*] | int64 | Position in the gradient, from 0 to 100. | | color | Object 2 | object | A preset gradient color palette. | | Object 2 | mode [*required*] | enum | Use a continuous color gradient. Allowed enum values: `gradient`. | | Object 2 | preset_name [*required*] | string | Name of the preset color palette. | | Object 2 | source [*required*] | enum | Use a preset color palette. Allowed enum values: `preset`. | | color | Object 3 | object | Discrete thresholds with custom colors. | | Object 3 | bins [*required*] | [object] | Two to six bins. Omit `lower_bound` on the first bin. Subsequent lower bounds must be in ascending order. | | bins | color [*required*] | | A color string, or two color strings for the light and dark themes, in that order. | | color | Object 1 | string | | | color | Object 2 | [string] | Two color strings for the light and dark themes, in that order. | | bins | lower_bound | double | Inclusive lower bound. Omit for the first bin. | | Object 3 | mode [*required*] | enum | Use discrete color thresholds. Allowed enum values: `discrete`. | | Object 3 | source [*required*] | enum | Use custom colors. Allowed enum values: `custom`. | | color | Object 4 | object | A preset discrete color palette. | | Object 4 | mode [*required*] | enum | Use discrete color thresholds. Allowed enum values: `discrete`. | | Object 4 | preset_name [*required*] | string | Name of the preset color palette. | | Object 4 | source [*required*] | enum | Use a preset color palette. Allowed enum values: `preset`. | | | 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`. | | | description | string | Description of the widget. | | | label_column | object | Configuration of the group label column. | | label_column | width [*required*] | enum | Width of the label column. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | | legend | object | Legend configuration for the heatgrid widget. | | legend | show_caption | boolean | Whether to display the legend caption. | | | requests [*required*] | [object] | Widget requests. The widget displays one formula, which can combine multiple queries. | | requests | formulas | [object] | The single displayed formula can combine multiple queries. | | formulas | alias | string | Expression alias. | | formulas | conditional_formats | [object] | Conditional formatting rules. These rules do not affect heatgrid rendering. Use the widget-level `color` configuration to control cell colors. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | requests | queries [*required*] | [] | Queries returned directly or combined in a formula. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | requests | response_format [*required*] | enum | Response format for heatgrid queries. Allowed enum values: `timeseries`. | | | sort [*required*] | object | Ordering of the heatgrid rows. | | sort | nesting_display [*required*] | enum | Display groups as flat rows. Allowed enum values: `flat`. | | sort | sort_by [*required*] | | Sort rows by aggregated value or group label. | | sort_by | | object | Sort rows by their aggregated values. | | | aggregation [*required*] | enum | Aggregation used to order rows over the displayed time range. Allowed enum values: `avg`, `min`, `max`, `sum`. | | | order [*required*] | enum | Sort direction. Allowed enum values: `asc`, `desc`. | | | property [*required*] | enum | Sort by value. Allowed enum values: `value`. | | sort_by | | object | Sort rows by their group labels. | | | order [*required*] | enum | Sort direction. Allowed enum values: `asc`, `desc`. | | | property [*required*] | enum | Sort by label. Allowed enum values: `label`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the heatgrid widget. Allowed enum values: `heatgrid`. Default: `heatgrid`. | | definition | | 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. | | | 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`. | | | description | string | The description of the widget. | | | 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. | | | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | | markers | [object] | List of markers. | | markers | display_type | string | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. | | 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). | | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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. | | | show_legend | boolean | Whether or not to display the legend on this widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap`. Default: `heatmap`. | | | 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). | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | definition | | object | The host map widget graphs any metric across your hosts using the same visualization available from the main Host Map page. | | | 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`. | | | description | string | The description of the widget. | | | group | [string] | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `group_by` (infrastructure) or a `group` dimension (DDSQL) inside `requests` instead. | | | no_group_hosts | boolean | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `no_group_hosts` inside `requests` instead. | | | no_metric_hosts | boolean | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `no_metric_hosts` inside `requests` instead. | | | node_type | enum | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `node_type` inside `requests` instead. Allowed enum values: `host`, `container`. | | | notes | string | Notes on the title. | | | requests [*required*] | object | Query definition for the host map widget. Supports three mutually exclusive formats distinguished by `request_type`: the deprecated legacy metric-based format (`fill`/`size`, no `request_type`), the infrastructure-backed format (`request_type: infrastructure_hostmap`), and the DDSQL published-dataset format (`request_type: data_projection`). | | requests | child | object | Optional child entities for hierarchical visualization (for example, host → container). Only used by the infrastructure-backed format. | | child | child | object | Optional child request for hierarchical visualization (for example, hosts containing containers). Maximum one level of nesting. | | child | conditional_formats | [object] | List of conditional formatting rules applied to fill values. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | child | enrichments [*required*] | [object] | Metric or event queries joined to the entity set. Each formula specifies a visual dimension. | | enrichments | formulas [*required*] | [object] | List of formulas that operate on queries, each assigned to a visual dimension. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; `group` is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: `node`, `fill`, `size`, `group`. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | unit | | object | Custom unit. | | 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. | | enrichments | queries [*required*] | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | sort | object | Options for sorting group by results. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | sort | object | Options for sorting group by results. | | group_by | target | object | Target for user journey search. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | search | join_keys | object | Join keys for user journey queries. | | search | node_objects [*required*] | object | Node objects mapping. | | search | step_aliases | object | Step aliases mapping. | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | search | filters | object | Filters for retention queries. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | enrichments | response_format [*required*] | enum | Response format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar`. | | child | filter | string | Filter string for the entity set in tag format (for example, `env:prod`). | | child | group_by | [object] | Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. | | group_by | column [*required*] | string | Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`). | | group_by | key | string | Key within the column for nested attribute types (for example, `service` within `tags`). | | child | no_group_hosts | boolean | Whether to hide entities that have no group assignment. | | child | no_metric_hosts | boolean | Whether to hide entities that have no enrichment data. | | child | node_type [*required*] | enum | Which type of infrastructure entity to visualize in the host map. Allowed enum values: `host`, `container`, `pod`, `cluster`. | | child | request_type [*required*] | enum | Identifies this as an infrastructure-backed host map request. Allowed enum values: `infrastructure_hostmap`. | | child | style | object | Style configuration for the infrastructure host map. | | style | fill_max | double | Maximum value for the fill color scale. Omit to use automatic scaling. | | style | fill_min | double | Minimum value for the fill color scale. Omit to use automatic scaling. | | style | palette | string | Color palette name or alias. | | style | palette_flip | boolean | Whether to invert the color palette. | | child | conditional_formats | [object] | List of conditional formatting rules applied to fill values. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | child | enrichments [*required*] | [object] | Metric or event queries joined to the entity set. Each formula specifies a visual dimension. | | enrichments | formulas [*required*] | [object] | List of formulas that operate on queries, each assigned to a visual dimension. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; `group` is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: `node`, `fill`, `size`, `group`. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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. | | enrichments | queries [*required*] | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | enrichments | response_format [*required*] | enum | Response format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar`. | | child | filter | string | Filter string for the entity set in tag format (for example, `env:prod`). | | child | group_by | [object] | Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. | | group_by | column [*required*] | string | Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`). | | group_by | key | string | Key within the column for nested attribute types (for example, `service` within `tags`). | | child | no_group_hosts | boolean | Whether to hide entities that have no group assignment. | | child | no_metric_hosts | boolean | Whether to hide entities that have no enrichment data. | | child | node_type [*required*] | enum | Which type of infrastructure entity to visualize in the host map. Allowed enum values: `host`, `container`, `pod`, `cluster`. | | child | request_type [*required*] | enum | Identifies this as an infrastructure-backed host map request. Allowed enum values: `infrastructure_hostmap`. | | child | style | object | Style configuration for the infrastructure host map. | | style | fill_max | double | Maximum value for the fill color scale. Omit to use automatic scaling. | | style | fill_min | double | Minimum value for the fill color scale. Omit to use automatic scaling. | | style | palette | string | Color palette name or alias. | | style | palette_flip | boolean | Whether to invert the color palette. | | requests | conditional_formats | [object] | List of conditional formatting rules applied to fill values. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | conditional_formats | timeframe | string | Defines the displayed timeframe. | | conditional_formats | value [*required*] | double | Value for the comparator. | | requests | enrichments | [object] | Metric or event queries joined to the entity set. Each formula specifies a visual dimension. Only used by the infrastructure-backed format. | | enrichments | formulas [*required*] | [object] | List of formulas that operate on queries, each assigned to a visual dimension. | | formulas | alias | string | Expression alias. | | formulas | dimension [*required*] | enum | Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; `group` is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: `node`, `fill`, `size`, `group`. | | formulas | formula [*required*] | string | String expression built from queries, formulas, and functions. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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. | | enrichments | queries [*required*] | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | enrichments | response_format [*required*] | enum | Response format for the scalar formula request. Only `scalar` is supported. Allowed enum values: `scalar`. | | requests | fill | object | **DEPRECATED**: Deprecated - Legacy metric-based format. Use the infrastructure-backed (`request_type: infrastructure_hostmap`) or DDSQL (`request_type: data_projection`) format instead. | | 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.md#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.md#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.md#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.md#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.md#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.md#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.md#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 | filter | string | Filter string for the entity set in tag format (for example, `env:prod`). Only used by the infrastructure-backed format. | | requests | group_by | [object] | Defines how entities are grouped into tiles. The ordering of entries implies the grouping hierarchy. Only used by the infrastructure-backed format. | | group_by | column [*required*] | string | Column name from the entity table (for example, `cloud_provider`, `tags`, `labels`). | | group_by | key | string | Key within the column for nested attribute types (for example, `service` within `tags`). | | requests | limit | int64 | Maximum number of rows to return from the dataset query. Only used by the DDSQL format. | | requests | no_group_hosts | boolean | Whether to hide entities that have no group assignment. | | requests | no_metric_hosts | boolean | Whether to hide entities that have no enrichment data. | | requests | node_type | enum | Entity type to visualize. Only used by the infrastructure-backed format. Allowed enum values: `host`, `container`, `pod`, `cluster`. | | requests | projection | object | Maps dataset columns to map dimensions (entity, optional parent for grouping, fill, size). Only used by the DDSQL format. | | projection | dimensions [*required*] | [object] | List of column-to-dimension mappings for the projection. | | dimensions | alias | string | Alias used to label the column instead of its name. | | dimensions | column [*required*] | string | Source column name from the dataset. | | dimensions | dimension [*required*] | enum | Visual dimension for the host map widget. Used both by infrastructure-backed formulas and by DDSQL projection columns; `group` is only meaningful for DDSQL projection columns, where repeated entries define the grouping hierarchy. Allowed enum values: `node`, `fill`, `size`, `group`. | | dimensions | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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. | | projection | type [*required*] | enum | Type of the host map projection. Allowed enum values: `hostmap`. | | requests | query | object | Published-dataset query. Only used by the DDSQL format. | | query | data_source [*required*] | enum | Identifies this as a published-dataset list query. Allowed enum values: `dataset`. | | query | dataset_id [*required*] | string | ID of the published dataset to query. | | query | dataset_provider [*required*] | enum | Product page that published the dataset queried by a `DatasetListQuery`. `ddsql_query` is the only provider currently supported for host map widgets. Allowed enum values: `ddsql_query`. | | query | filter | string | Filter applied to the dataset's rows, using events-style search syntax. | | query | limit | int64 | Maximum number of rows to return from the dataset query. | | query | sort | object | Sort configuration for a `DatasetListQuery`. | | sort | fields [*required*] | [object] | List of fields to sort the rows by, applied in order. | | fields | name [*required*] | string | Name of the field to sort on. | | fields | order [*required*] | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | requests | request_type | enum | Identifies which host map request format the sibling fields on `HostMapWidgetDefinitionRequests` describe: an infrastructure-backed request or a DDSQL published-dataset request. Allowed enum values: `infrastructure_hostmap`, `data_projection`. | | requests | size | object | **DEPRECATED**: Deprecated - Legacy metric-based format. Use the infrastructure-backed (`request_type: infrastructure_hostmap`) or DDSQL (`request_type: data_projection`) format instead. | | 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.md#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.md#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.md#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.md#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.md#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.md#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.md#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 | Style configuration for the infrastructure host map. | | style | fill_max | double | Maximum value for the fill color scale. Omit to use automatic scaling. | | style | fill_min | double | Minimum value for the fill color scale. Omit to use automatic scaling. | | style | palette | string | Color palette name or alias. | | style | palette_flip | boolean | Whether to invert the color palette. | | | scope | [string] | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `filter` inside `requests` instead. | | | style | object | **DEPRECATED**: Deprecated - Only used by the legacy metric-based format. Use `style` inside `requests` instead. | | 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. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the host map widget. Allowed enum values: `hostmap`. Default: `hostmap`. | | definition | | object | The iframe widget allows you to embed a portion of any other web page on your dashboard. | | | type [*required*] | enum | Type of the iframe widget. Allowed enum values: `iframe`. Default: `iframe`. | | | url [*required*] | string | URL of the iframe. | | definition | | object | The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. | | | has_background | boolean | Whether to display a background or not. Default: `true`. | | | has_border | boolean | Whether to display a border or not. Default: `true`. | | | horizontal_align | enum | Horizontal alignment. Allowed enum values: `center`, `left`, `right`. | | | margin | enum | Size of the margins around the image. **Note**: `small` and `large` values are deprecated. Allowed enum values: `sm`, `md`, `lg`, `small`, `large`. | | | 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`. | | | type [*required*] | enum | Type of the image widget. Allowed enum values: `image`. Default: `image`. | | | url [*required*] | string | URL of the image. | | | url_dark_theme | string | URL of the image in dark mode. | | | vertical_align | enum | Vertical alignment. Allowed enum values: `center`, `top`, `bottom`. | | definition | | object | The list stream visualization displays a table of recent events in your application that match a search criteria using user-defined columns. | | | description | string | The description of the widget. | | | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | | requests [*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 | assignee_uuids | [string] | Filter by assignee UUIDs. Usable only with `issue_stream`. | | 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`, `max`, `avg`, `earliest`, `latest`, `most_frequent`. | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. 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`, `event_stream`, `rum_stream`, `llm_observability_stream`, `issue_stream`, `security_runtime_stream`, `security_signals_stream`, `incidents_stream`, `case_stream`. Default: `logs_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 | persona | enum | Persona filter for the `issue_stream` data source. Allowed enum values: `all`, `browser`, `mobile`, `backend`. | | 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 | states | [string] | Filter by issue states. Usable only with `issue_stream`. | | query | storage | string | Option for storage location. Feature in Private Beta. | | query | suspected_causes | [string] | Filter by suspected causes. Usable only with `issue_stream`. | | query | team_handles | [string] | Filter by team handles. Usable only with `issue_stream`. | | query | version | enum | Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** Allowed enum values: `sequential_query`. | | requests | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list`. | | | show_legend | boolean | Whether or not to display the legend on this widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the list stream widget. Allowed enum values: `list_stream`. Default: `list_stream`. | | definition | | object | The Log Stream displays a log flow matching the defined query. | | | columns | [string] | Which columns to display on the widget. | | | description | string | The description of the widget. | | | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | | logset | string | **DEPRECATED**: ID of the log set to use. | | | message_display | enum | Amount of log lines to display Allowed enum values: `inline`, `expanded-md`, `expanded-lg`. | | | query | string | Query to filter the log stream with. | | | show_date_column | boolean | Whether to show the date column or not | | | show_message_column | boolean | Whether to show the message column or not | | | sort | 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`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream`. Default: `log_stream`. | | definition | | object | The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. | | | color_preference | enum | Which color to use on the widget. Allowed enum values: `background`, `text`. | | | count | int64 | **DEPRECATED**: The number of monitors to display. | | | description | string | The description of the widget. | | | display_format | enum | What to display on the widget. Allowed enum values: `counts`, `countsAndList`, `list`. | | | hide_zero_counts | boolean | Whether to show counts of 0 or not. | | | query [*required*] | string | Query to filter the monitors with. | | | show_last_triggered | boolean | Whether to show the time that has elapsed since the monitor/group triggered. | | | show_priority | boolean | Whether to show the priorities column. Default: `false`. | | | sort | enum | Widget sorting methods. Allowed enum values: `name`, `group`, `status`, `tags`, `triggered`, `group,asc`, `group,desc`, `name,asc`, `name,desc`, `status,asc`, `status,desc`, `tags,asc`, `tags,desc`, `triggered,asc`, `triggered,desc`, `priority,asc`, `priority,desc`. | | | start | int64 | **DEPRECATED**: The start of the list. Typically 0. | | | summary_type | enum | Which summary type should be used. Allowed enum values: `monitors`, `groups`, `combined`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the monitor summary widget. Allowed enum values: `manage_status`. Default: `manage_status`. | | definition | | object | The notes and links widget is similar to free text widget, but allows for more formatting options. | | | background_color | string | Background color of the note. | | | content [*required*] | string | Content of the note. | | | font_size | string | Size of the text. | | | has_padding | boolean | Whether to add padding or not. Default: `true`. | | | show_tick | boolean | Whether to show a tick or not. | | | text_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | tick_edge | enum | Define how you want to align the text on the widget. Allowed enum values: `bottom`, `left`, `right`, `top`. | | | tick_pos | string | Where to position the tick on an edge. | | | type [*required*] | enum | Type of the note widget. Allowed enum values: `note`. Default: `note`. | | | vertical_align | enum | Vertical alignment. Allowed enum values: `center`, `top`, `bottom`. | | definition | | 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. | | | background_color | string | Background color of the powerpack title. | | | banner_img | string | URL of image to display as a banner for the powerpack. | | | powerpack_id [*required*] | string | UUID of the associated powerpack. | | | show_title | boolean | Whether to show the title or not. Default: `true`. | | | 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. | | | title | string | Title of the widget. | | | type [*required*] | enum | Type of the powerpack widget. Allowed enum values: `powerpack`. Default: `powerpack`. | | definition | | object | The point plot displays individual data points over time. | | | 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`. | | | description | string | The description of the widget. | | | legend | object | Legend configuration for the point plot widget. | | legend | type [*required*] | enum | Type of legend to show for the point plot widget. Allowed enum values: `automatic`, `none`. | | | markers | [object] | List of markers for the widget. | | markers | display_type | string | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. | | 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). | | | requests [*required*] | [object] | List of request configurations for the widget. | | requests | limit | int64 | Maximum number of data points to return. | | requests | projection [*required*] | object | Projection configuration for the point plot widget. | | projection | dimensions [*required*] | [object] | List of dimension mappings for the projection. | | dimensions | alias | string | Alias for the column. | | dimensions | column [*required*] | string | Source column name from the dataset. | | dimensions | dimension [*required*] | enum | Dimension of the point plot. Allowed enum values: `group`, `time`, `y`, `radius`. | | projection | extra_columns | [string] | Additional columns to include in the projection. | | projection | type [*required*] | enum | Type of the projection. Allowed enum values: `point_plot`. | | requests | query [*required*] | object | Query configuration for a data projection request. | | query | data_source [*required*] | string | Data source for the query. | | query | indexes | [string] | List of indexes to query. | | query | query_string [*required*] | string | The query string to filter events. | | query | storage | string | Storage location for the query. | | requests | request_type [*required*] | enum | Type of a data projection request. Allowed enum values: `data_projection`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the point plot widget. Allowed enum values: `point_plot`. Default: `point_plot`. | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | definition | | object | Query values display the current value of a given metric, APM, or log query. | | | autoscale | boolean | Whether to use auto-scaling or not. | | | custom_links | [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`. | | | custom_unit | string | Display a unit of your choice on the widget. | | | description | string | The description of the widget. | | | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | | 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.md#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.md#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 | comparison | object | Displays a change indicator showing a delta against a historical baseline. | | comparison | directionality | enum | Which direction of change is considered an improvement, determining the indicator color. Allowed enum values: `increase_better`, `decrease_better`, `neutral`. Default: `neutral`. | | comparison | duration [*required*] | object | The comparison period. Use a preset `type` value or set `type` to `custom_timeframe` and provide `custom_timeframe` with explicit millisecond epoch bounds. | | duration | custom_timeframe | object | Required when `type` is `custom_timeframe`. Fixed time range to compare against. | | custom_timeframe | from [*required*] | int64 | Start time in milliseconds since epoch. | | custom_timeframe | to [*required*] | int64 | End time in milliseconds since epoch. | | duration | type [*required*] | enum | The comparison window type. Allowed enum values: `previous_timeframe`, `custom_timeframe`, `previous_day`, `previous_week`, `previous_month`. | | comparison | type | enum | How the delta is expressed: `absolute` (raw difference), `relative` (percentage), or `both`. Allowed enum values: `absolute`, `relative`, `both`. Default: `absolute`. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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. | | | text_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | 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`. Default: `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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value`. Default: `query_value`. | | definition | | object | The retention curve widget visualizes user retention rates over time. | | | description | string | The description of the widget. | | | requests [*required*] | [object] | List of Retention Curve widget requests. | | requests | query [*required*] | object | Retention query definition. | | query | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | query | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | query | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | query | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | query | name | string | Name of the query. | | query | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | requests | request_type [*required*] | enum | Request type for retention curve widget. Allowed enum values: `retention_curve`. | | requests | style | object | Style configuration for retention curve. | | style | palette | string | Color palette for the retention curve. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the Retention Curve widget. Allowed enum values: `retention_curve`. Default: `retention_curve`. | | definition | | object | Run workflow is widget that allows you to run a workflow from a dashboard. | | | 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`. | | | description | string | The description of the widget. | | | 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'. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the run workflow widget. Allowed enum values: `run_workflow`. Default: `run_workflow`. | | | workflow_id [*required*] | string | Workflow id. | | definition | | object | Use the SLO List widget to track your SLOs (Service Level Objectives) on dashboards. | | | description | string | The description of the widget. | | | 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. Default: `100`. | | 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`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the SLO List widget. Allowed enum values: `slo_list`. Default: `slo_list`. | | definition | | object | Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | description | string | The description of the widget. | | | global_time_target | string | Defined global time target. | | | show_error_budget | boolean | Defined error budget. | | | slo_id | string | ID of the SLO displayed. | | | time_windows | [string] | Times being monitored. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the SLO widget. Allowed enum values: `slo`. Default: `slo`. | | | view_mode | enum | Define how you want the SLO to be displayed. Allowed enum values: `overall`, `component`, `both`. | | | view_type [*required*] | string | Type of view displayed by the widget. Default: `detail`. | | definition | | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | | color_by_groups | [string] | List of groups used for colors. | | | custom_links | [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`. | | | description | string | The description of the widget. | | | 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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot`. Default: `scatterplot`. | | | 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`. Default: `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | definition | | object | The Sankey diagram visualizes the flow of data between categories, stages or sets of values. | | | requests [*required*] | [] | List of Sankey widget requests. | | requests | | object | Sankey widget request for Product Analytics or RUM data source. | | | query [*required*] | object | Query configuration for Product Analytics or RUM Sankey widget. | | query | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | query | data_source [*required*] | enum | Product Analytics or RUM data source type. Allowed enum values: `rum`, `product_analytics`. Default: `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 Product Analytics or RUM queries. Allowed enum values: `source`, `target`. Default: `source`. | | query | number_of_steps | int64 | Number of steps. | | query | occurrences | object | Filter applied to occurrence counts when building a Product Analytics audience. | | occurrences | operator | string | The comparison operator used for the occurrence filter (for example: `gt`, `lt`, `eq`). | | occurrences | value | string | The threshold value to compare occurrence counts against. | | query | query_string [*required*] | string | RUM event search query used to filter views or actions. | | query | source | string | Source. | | query | subquery_id | string | Subquery ID. | | query | target | string | Target. | | | request_type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey`. Default: `sankey`. | | requests | | object | Sankey widget request for network data source. | | | 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 | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 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`. Default: `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`. Default: `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`. | | | request_type [*required*] | enum | Type of request for network Sankey widget. Allowed enum values: `netflow_sankey`. Default: `netflow_sankey`. | | | show_other_links | boolean | Whether to show links for "other" category. | | | sort_nodes | boolean | Whether to sort nodes in the Sankey diagram. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the Sankey widget. Allowed enum values: `sankey`. Default: `sankey`. | | definition | | 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. | | | 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`. | | | description | string | The description of the widget. | | | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | | service [*required*] | string | The ID of the service you want to map. | | | title | string | The title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the service map widget. Allowed enum values: `servicemap`. Default: `servicemap`. | | definition | | object | The service summary displays the graphs of a chosen service in your dashboard. | | | description | string | The description of the widget. | | | display_format | enum | Number of columns to display. Allowed enum values: `one_column`, `two_column`, `three_column`. | | | env [*required*] | string | APM environment. | | | service [*required*] | string | APM service. | | | show_breakdown | boolean | Whether to show the latency breakdown or not. | | | show_distribution | boolean | Whether to show the latency distribution or not. | | | show_errors | boolean | Whether to show the error metrics or not. | | | show_hits | boolean | Whether to show the hits metrics or not. | | | show_latency | boolean | Whether to show the latency metrics or not. | | | show_resource_list | boolean | Whether to show the resource list or not. | | | size_format | enum | Size of the widget. Allowed enum values: `small`, `medium`, `large`. | | | span_name [*required*] | string | APM span name. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the service summary widget. Allowed enum values: `trace_service`. Default: `trace_service`. | | definition | | 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) | | | has_uniform_y_axes | boolean | Normalize y axes across graphs | | | size [*required*] | enum | Size of the individual graphs in the split. Allowed enum values: `xs`, `sm`, `md`, `lg`. | | | source_widget_definition [*required*] | | The original widget we are splitting on. | | source_widget_definition | | object | The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups. | | | 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`. | | | description | string | The description of the widget. | | | 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | style | object | Style customization for a bar chart widget. | | style | display | | Bar chart widget display options. | | display | | object | Bar chart widget stacked display options. | | | legend | enum | Bar chart widget stacked legend behavior. Allowed enum values: `automatic`, `inline`, `none`. | | | type [*required*] | enum | Bar chart widget stacked display type. Allowed enum values: `stacked`. Default: `stacked`. | | display | | object | Bar chart widget flat display. | | | type [*required*] | enum | Bar chart widget flat display type. Allowed enum values: `flat`. Default: `flat`. | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Bar chart widget scaling definition. Allowed enum values: `absolute`, `relative`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the bar chart widget. Allowed enum values: `bar_chart`. Default: `bar_chart`. | | source_widget_definition | | object | The Change graph shows you the change in a value over the time period chosen. | | | 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`. | | | description | string | The description of the widget. | | | 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.md) 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the change widget. Allowed enum values: `change`. Default: `change`. | | source_widget_definition | | object | This visualization displays a series of values by country on a world map. | | | 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`. | | | description | string | The description of the widget. | | | 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.md) 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | requests | query | object | Updated list stream widget. | | query | assignee_uuids | [string] | Filter by assignee UUIDs. Usable only with `issue_stream`. | | 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`, `max`, `avg`, `earliest`, `latest`, `most_frequent`. | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. 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`, `event_stream`, `rum_stream`, `llm_observability_stream`, `issue_stream`, `security_runtime_stream`, `security_signals_stream`, `incidents_stream`, `case_stream`. Default: `logs_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 | persona | enum | Persona filter for the `issue_stream` data source. Allowed enum values: `all`, `browser`, `mobile`, `backend`. | | 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 | states | [string] | Filter by issue states. Usable only with `issue_stream`. | | query | storage | string | Option for storage location. Feature in Private Beta. | | query | suspected_causes | [string] | Filter by suspected causes. Usable only with `issue_stream`. | | query | team_handles | [string] | Filter by team handles. Usable only with `issue_stream`. | | query | version | enum | Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** Allowed enum values: `sequential_query`. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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`, `custom_text`. Default: `white_on_green`. | | text_formats | replace | | Replace rule for the table widget text format. | | replace | | object | Match All definition. | | | type [*required*] | enum | Table widget text format replace all type. Allowed enum values: `all`. | | | with [*required*] | string | Replace All type. | | replace | | object | Match Sub-string definition. | | | substring [*required*] | string | Text that will be replaced. | | | type [*required*] | enum | Table widget text format replace sub-string type. Allowed enum values: `substring`. | | | with [*required*] | string | Text that will replace original sub-string. | | | 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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | The title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | The size of the title. | | | type [*required*] | enum | Type of the geomap widget. Allowed enum values: `geomap`. Default: `geomap`. | | | 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 | | object | Query values display the current value of a given metric, APM, or log query. | | | autoscale | boolean | Whether to use auto-scaling or not. | | | custom_links | [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`. | | | custom_unit | string | Display a unit of your choice on the widget. | | | description | string | The description of the widget. | | | precision | int64 | Number of decimals to show. If not defined, the widget uses the raw value. | | | 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.md#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.md#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 | comparison | object | Displays a change indicator showing a delta against a historical baseline. | | comparison | directionality | enum | Which direction of change is considered an improvement, determining the indicator color. Allowed enum values: `increase_better`, `decrease_better`, `neutral`. Default: `neutral`. | | comparison | duration [*required*] | object | The comparison period. Use a preset `type` value or set `type` to `custom_timeframe` and provide `custom_timeframe` with explicit millisecond epoch bounds. | | duration | custom_timeframe | object | Required when `type` is `custom_timeframe`. Fixed time range to compare against. | | custom_timeframe | from [*required*] | int64 | Start time in milliseconds since epoch. | | custom_timeframe | to [*required*] | int64 | End time in milliseconds since epoch. | | duration | type [*required*] | enum | The comparison window type. Allowed enum values: `previous_timeframe`, `custom_timeframe`, `previous_day`, `previous_week`, `previous_month`. | | comparison | type | enum | How the delta is expressed: `absolute` (raw difference), `relative` (percentage), or `both`. Allowed enum values: `absolute`, `relative`, `both`. Default: `absolute`. | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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. | | | text_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | 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`. Default: `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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the query value widget. Allowed enum values: `query_value`. Default: `query_value`. | | source_widget_definition | | object | The scatter plot visualization allows you to graph a chosen scope over two different metrics with their respective aggregation. | | | color_by_groups | [string] | List of groups used for colors. | | | custom_links | [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`. | | | description | string | The description of the widget. | | | 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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | sort | object | Options for sorting group by results. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | sort | object | Options for sorting group by results. | | group_by | target | object | Target for user journey search. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | search | join_keys | object | Join keys for user journey queries. | | search | node_objects [*required*] | object | Node objects mapping. | | search | step_aliases | object | Step aliases mapping. | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | search | filters | object | Filters for retention queries. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | 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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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.md#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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the scatter plot widget. Allowed enum values: `scatterplot`. Default: `scatterplot`. | | | 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`. Default: `auto`. | | xaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | xaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | source_widget_definition | | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | | 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`. | | | description | string | The description of the widget. | | | hide_total | boolean | Show the total value in this widget. | | | legend | | Configuration of the legend. | | legend | Object 1 | object | Configuration of table-based legend. | | Object 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table`, `none`. | | legend | Object 2 | object | Configuration of inline or automatic legends. | | Object 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Object 2 | hide_value | boolean | Whether to hide the values of the groups. | | Object 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline`, `automatic`. | | | 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.md#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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group`. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst`. Default: `sunburst`. | | source_widget_definition | | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | | 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`. | | | description | string | The description of the widget. | | | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always`, `never`, `auto`. | | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table`. Default: `query_table`. | | source_widget_definition | | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | | 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`. | | | description | string | The description of the widget. | | | 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. | | | legend_columns | [string] | Columns displayed in the legend. | | | legend_layout | enum | Layout of the legend. Allowed enum values: `auto`, `horizontal`, `vertical`. | | | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | | markers | [object] | List of markers. | | markers | display_type | string | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. | | 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). | | | 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.md#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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | 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`. Default: `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | show_legend | boolean | (screenboard only) Show the legend for this widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries`. Default: `timeseries`. | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | source_widget_definition | | 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. | | | 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`. | | | description | string | The description of the widget. | | | 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | | object | Top list widget stacked display options. | | | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic`, `inline`, `none`. | | | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked`. Default: `stacked`. | | display | | object | Top list widget flat display. | | | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat`. Default: `flat`. | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute`, `relative`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist`. Default: `toplist`. | | source_widget_definition | | 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. | | | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`. Default: `user`. | | | 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`. | | | description | string | The description of the widget. | | | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user`, `family`, `process`. | | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 1 | sort | object | Options for sorting group by results. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 2 | sort | object | Options for sorting group by results. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | graph_filters | [object] | Graph filters. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | return_criteria | time_interval | object | Time interval for return criteria. | | 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 | 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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu`, `pct_mem`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap`. Default: `treemap`. | | | 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 | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | type [*required*] | enum | Type of the split graph widget Allowed enum values: `split_group`. Default: `split_group`. | | definition | | object | Sunbursts are spot on to highlight how groups contribute to the total of a query. | | | 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`. | | | description | string | The description of the widget. | | | hide_total | boolean | Show the total value in this widget. | | | legend | | Configuration of the legend. | | legend | Object 1 | object | Configuration of table-based legend. | | Object 1 | type [*required*] | enum | Whether or not to show a table legend. Allowed enum values: `table`, `none`. | | legend | Object 2 | object | Configuration of inline or automatic legends. | | Object 2 | hide_percent | boolean | Whether to hide the percentages of the groups. | | Object 2 | hide_value | boolean | Whether to hide the values of the groups. | | Object 2 | type [*required*] | enum | Whether to show the legend inline or let it be automatically generated. Allowed enum values: `inline`, `automatic`. | | | 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.md#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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group`. | | requests | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the Sunburst widget. Allowed enum values: `sunburst`. Default: `sunburst`. | | definition | | object | The table visualization is available on dashboards. It displays columns of metrics grouped by tag key. | | | 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`. | | | description | string | The description of the widget. | | | has_search_bar | enum | Controls the display of the search bar. Allowed enum values: `always`, `never`, `auto`. | | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the table widget. Allowed enum values: `query_table`. Default: `query_table`. | | definition | | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | | 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`. | | | description | string | The description of the widget. | | | 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. | | | legend_columns | [string] | Columns displayed in the legend. | | | legend_layout | enum | Layout of the legend. Allowed enum values: `auto`, `horizontal`, `vertical`. | | | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | | markers | [object] | List of markers. | | markers | display_type | string | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `percentile`. | | 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). | | | 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.md#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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | 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`. Default: `auto`. | | right_yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | right_yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | | show_legend | boolean | (screenboard only) Show the legend for this widget. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries`. Default: `timeseries`. | | | 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`. Default: `auto`. | | yaxis | min | string | Specifies minimum numeric value to show on the axis. Defaults to `auto`. Default: `auto`. | | yaxis | scale | string | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`). Default: `linear`. | | definition | | 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. | | | 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`. | | | description | string | The description of the widget. | | | 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.md#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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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.md#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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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.md#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.md#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.md#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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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.md#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.md#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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | style | object | Style customization for a top list widget. | | style | display | | Top list widget display options. | | display | | object | Top list widget stacked display options. | | | legend | enum | Top list widget stacked legend behavior. Allowed enum values: `automatic`, `inline`, `none`. | | | type [*required*] | enum | Top list widget stacked display type. Allowed enum values: `stacked`. Default: `stacked`. | | display | | object | Top list widget flat display. | | | type [*required*] | enum | Top list widget flat display type. Allowed enum values: `flat`. Default: `flat`. | | style | palette | string | Color palette to apply to the widget. | | style | scaling | enum | Top list widget scaling definition. Allowed enum values: `absolute`, `relative`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist`. Default: `toplist`. | | definition | Object 41 | | This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget. | | Object 41 | Object 1 | object | Topology map widget backed by the data streams data source. | | Object 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`. | | Object 1 | description | string | The description of the widget. | | Object 1 | requests [*required*] | [object] | One Topology request. | | requests | query | object | Query to the data streams topology data source. | | query | data_source [*required*] | enum | Name of the data source. Allowed enum values: `data_streams`. | | query | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | query | query_string | string | A search string for filtering services. When set, this replaces the `service` field. | | query | service [*required*] | string | (deprecated) Name of the service. Leave this empty and use query_string instead. | | requests | request_type | enum | Widget request type. Allowed enum values: `topology`. | | Object 1 | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | Object 1 | title | string | Title of your widget. | | Object 1 | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | Object 1 | title_size | string | Size of the title. | | Object 1 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map`. Default: `topology_map`. | | Object 41 | Object 2 | object | Topology map widget backed by the service map data source. | | Object 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`. | | Object 2 | description | string | The description of the widget. | | Object 2 | requests [*required*] | [object] | One Topology request. | | requests | query | object | Query to the service map topology data source. | | query | data_source [*required*] | enum | Name of the data source. Allowed enum values: `service_map`. | | query | filters [*required*] | [string] | Your environment and primary tag (or * if enabled for your account). | | query | query_string | string | A search string for filtering services. When set, this replaces the `service` field. | | query | service [*required*] | string | (deprecated) Name of the service. Leave this empty and use query_string instead. | | requests | request_type | enum | Widget request type. Allowed enum values: `topology`. | | Object 2 | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | Object 2 | title | string | Title of your widget. | | Object 2 | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | Object 2 | title_size | string | Size of the title. | | Object 2 | type [*required*] | enum | Type of the topology map widget. Allowed enum values: `topology_map`. Default: `topology_map`. | | definition | | 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. | | | color_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine color in the widget. Allowed enum values: `user`. Default: `user`. | | | 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`. | | | description | string | The description of the widget. | | | group_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to group elements in the widget. Allowed enum values: `user`, `family`, `process`. | | | 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | 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 | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | value | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | value | quantity | int64 | Quantity of the interval. | | value | timezone | string | Timezone for the interval. | | value | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | 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 | 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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | | size_by | enum | **DEPRECATED**: (deprecated) The attribute formerly used to determine size in the widget. Allowed enum values: `pct_cpu`, `pct_mem`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of your widget. | | | type [*required*] | enum | Type of the treemap widget. Allowed enum values: `treemap`. Default: `treemap`. | | definition | | 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. | | | 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`. | | | requests [*required*] | [] | List of data requests for the wildcard widget. | | requests | Object 1 | object | An updated treemap widget. | | Object 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Object 1 | q | string | **DEPRECATED**: The widget metrics query. Deprecated - Use `queries` and `formulas` instead. | | Object 1 | queries | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | Object 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`. | | Object 1 | 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 | | object | The formula to sort the widget by. | | | index [*required*] | int64 | The index of the formula to sort by. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to formula. Allowed enum values: `formula`. | | order_by | | object | The group to sort the widget by. | | | name [*required*] | string | The name of the group. | | | order [*required*] | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | | type [*required*] | enum | Set the sort type to group. Allowed enum values: `group`. | | Object 1 | 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | requests | Object 2 | object | Updated timeseries widget. | | Object 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.md#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. | | Object 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.md#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. | | Object 2 | display_type | enum | Type of display to use for the request. Allowed enum values: `area`, `bars`, `line`, `overlay`. | | Object 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.md#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. | | Object 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Object 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.md#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. | | Object 2 | metadata | [object] | Used to define expression aliases. | | metadata | alias_name | string | Expression alias. | | metadata | expression [*required*] | string | Expression name. | | Object 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.md#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. | | Object 2 | on_right_yaxis | boolean | Whether or not to display a second y-axis on the right. | | Object 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. | | Object 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.md#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. | | Object 2 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Object 2 | queries | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | Object 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`. | | Object 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.md#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. | | Object 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.md#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. | | Object 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. - `tags`: Order series alphabetically by tag name (default behavior) - `values`: Order series by their current metric values (typically descending) Allowed enum values: `tags`, `values`. | | style | palette | string | Color palette to apply to the widget. | | requests | Object 3 | object | Updated list stream widget. | | Object 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`. | | Object 3 | query [*required*] | object | Updated list stream widget. | | query | assignee_uuids | [string] | Filter by assignee UUIDs. Usable only with `issue_stream`. | | 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`, `max`, `avg`, `earliest`, `latest`, `most_frequent`. | | compute | facet | string | Facet name. | | query | data_source [*required*] | enum | Source from which to query items to display in the stream. apm_issue_stream, rum_issue_stream, and logs_issue_stream are deprecated. Use issue_stream instead. 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`, `event_stream`, `rum_stream`, `llm_observability_stream`, `issue_stream`, `security_runtime_stream`, `security_signals_stream`, `incidents_stream`, `case_stream`. Default: `logs_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 | persona | enum | Persona filter for the `issue_stream` data source. Allowed enum values: `all`, `browser`, `mobile`, `backend`. | | 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 | states | [string] | Filter by issue states. Usable only with `issue_stream`. | | query | storage | string | Option for storage location. Feature in Private Beta. | | query | suspected_causes | [string] | Filter by suspected causes. Usable only with `issue_stream`. | | query | team_handles | [string] | Filter by team handles. Usable only with `issue_stream`. | | query | version | enum | Version of the query for the logs transaction stream widget. When omitted, v1 query behavior is preserved. Set to `sequential_query` to use v2 behavior. **This feature is in Preview.** Allowed enum values: `sequential_query`. | | Object 3 | response_format [*required*] | enum | Widget response format. Allowed enum values: `event_list`. | | requests | Object 4 | object | Updated distribution widget. | | Object 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.md#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. | | Object 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. | | Object 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.md#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. | | Object 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`, `white_on_gray`, `white_on_green`, `green_on_white`, `white_on_red`, `white_on_yellow`, `yellow_on_white`, `black_on_light_yellow`, `black_on_light_green`, `black_on_light_red`. | | 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`. Default: `desc`. | | formulas | number_format | object | Number format options for the widget. | | number_format | unit | | Number format unit. | | unit | | object | Canonical unit. | | | per_unit_name | string | The name of the unit per item. | | | type | enum | The type of unit scale. Allowed enum values: `canonical_unit`. | | | unit_name | string | The name of the unit. | | unit | | object | Custom unit. | | | label | string | The label for the custom unit. | | | 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.md) | | style | palette_index | int64 | Index specifying which color to use within the palette. | | Object 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.md#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. | | Object 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.md#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. | | Object 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. | | Object 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.md#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. | | Object 4 | q | string | **DEPRECATED**: Widget query. Deprecated - Use `queries` and `formulas` instead. | | Object 4 | queries | [] | List of queries that can be returned directly or used in formulas. | | queries | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | queries | Object 3 | object | Process query using formulas and functions. | | Object 3 | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | Object 3 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 3 | data_source [*required*] | enum | Data sources that rely on the process backend. Allowed enum values: `process`, `container`. | | Object 3 | is_normalized_cpu | boolean | Whether to normalize the CPU percentages. | | Object 3 | limit | int64 | Number of hits to return. | | Object 3 | metric [*required*] | string | Process metric name. | | Object 3 | name [*required*] | string | Name of query for use in formulas. | | Object 3 | sort | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 3 | tag_filters | [string] | An array of tags to filter by. | | Object 3 | text_filter | string | Text to use as filter. | | queries | | object | A formula and functions APM dependency stats query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM dependency stats queries. Allowed enum values: `apm_dependency_stats`. | | | env [*required*] | string | APM environment. | | | is_upstream | boolean | Determines whether stats for upstream or downstream dependencies should be queried. | | | name [*required*] | string | Name of query to use in formulas. | | | operation_name [*required*] | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog). | | | primary_tag_value | string | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | | | resource_name [*required*] | string | APM resource. | | | service [*required*] | string | APM service. | | | 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 | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | queries | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | queries | | object | A formula and functions metrics query. | | | additional_query_filters | string | Additional filters applied to the SLO query. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for SLO measures queries. Allowed enum values: `slo`. | | | group_mode | enum | Group mode to query measures. Allowed enum values: `overall`, `components`. | | | 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`. | | | name | string | Name of the query for use in formulas. | | | slo_id [*required*] | string | ID of an SLO to query measures. | | | slo_query_type | enum | Name of the query for use in formulas. Allowed enum values: `metric`, `monitor`, `time_slice`. | | queries | | object | A formula and functions Cloud Cost query. | | | aggregator | enum | Aggregator used for the request. Allowed enum values: `avg`, `last`, `max`, `min`, `sum`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for Cloud Cost queries. Allowed enum values: `cloud_cost`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Query for Cloud Cost data. | | queries | | object | A formula and functions Product Analytics Extended query for advanced analytics features. | | | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | accounts | name | string | The name of the account subquery. | | accounts | query | string | The query string for the account subquery. | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | segments | name | string | The name of the segment subquery. | | segments | segment_id | string | The unique identifier of the segment. | | audience_filters | users | [object] | | | users | name | string | The name of the user subquery. | | users | query | string | The query string for the user subquery. | | | compute [*required*] | object | Compute configuration for Product Analytics Extended queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`. | | compute | metric | string | Measurable attribute to compute. | | compute | name | string | Name of the compute for use in formulas. | | compute | rollup | object | Calendar-aligned time bucket for time series queries (for example, day, week, or month boundaries). Mutually exclusive with `interval`. | | rollup | alignment | string | Alignment of the interval. Valid values depend on the interval type. For `day`, use hours (for example, `1am`, `2pm`, or `14`). For `week`, use day names (for example, `monday`). For `month`, use day-of-month ordinals (for example, `1st`, `15th`). For `year` or `quarter`, use month names (for example, `january`). | | rollup | quantity | int64 | Quantity of the interval. | | rollup | timezone | string | Timezone for the interval. | | rollup | type [*required*] | enum | Type of calendar interval. Allowed enum values: `day`, `week`, `month`, `year`, `quarter`, `minute`, `hour`. | | | data_source [*required*] | enum | Data source for Product Analytics Extended queries. Allowed enum values: `product_analytics_extended`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | | indexes | [string] | Event indexes to query. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | object | Base query for Product Analytics. | | query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | query | search [*required*] | object | Search configuration for Product Analytics event query. | | search | query [*required*] | string | RUM event search query used to filter views or actions. | | queries | | object | A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data. | | | compute [*required*] | object | Compute configuration for User Journey formula queries. | | compute | aggregation [*required*] | enum | Aggregation methods for event platform queries. Allowed enum values: `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. | | compute | interval | double | Time bucket interval in milliseconds for time series queries. | | compute | metric | enum | Metric for User Journey formula compute. `__dd.conversion` and `__dd.conversion_rate` accept `count` and `cardinality` as aggregations. `__dd.time_to_convert` accepts `avg`, `median`, `pc75`, `pc95`, `pc98`, `pc99`, `min`, and `max`. Allowed enum values: `__dd.conversion`, `__dd.conversion_rate`, `__dd.time_to_convert`. | | compute | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | data_source [*required*] | enum | Data source for user journey funnel queries. Allowed enum values: `product_analytics_journey`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet name to group by. | | group_by | limit | int32 | Maximum number of groups to return. | | group_by | should_exclude_missing | boolean | Whether to exclude events missing the group-by facet. | | group_by | 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | target | object | Target for user journey search. | | target | end | string | End value. | | target | start | string | Start value. | | target | type [*required*] | string | Target type. | | target | value | string | Target value. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | User journey search configuration. | | search | expression [*required*] | string | Expression string. | | search | filters | object | Filters for user journey search. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | graph_filters | [object] | Graph filters. | | graph_filters | name | string | Filter name. | | graph_filters | operator | string | Filter operator. | | graph_filters | target | object | Target for user journey search. | | graph_filters | value | int64 | Filter value. | | filters | string_filter | string | String filter. | | search | join_keys | object | Join keys for user journey queries. | | join_keys | primary [*required*] | string | Primary join key. | | join_keys | secondary | [string] | Secondary join keys. | | search | node_objects [*required*] | object | Node objects mapping. | | additionalProperties | | object | Base query for Product Analytics. | | | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | | search [*required*] | object | Search configuration for Product Analytics event query. | | search | step_aliases | object | Step aliases mapping. | | additionalProperties | | string | | | queries | | object | A formula and functions Retention query for defining timeseries and scalar visualizations. | | | compute [*required*] | object | Compute configuration for retention queries. | | compute | aggregation [*required*] | | The type of aggregation that can be performed on events-based queries. | | aggregation | Object 1 | enum | Standard aggregation types for events-based queries. Allowed enum values: `avg`, `cardinality`, `count`, `delta`, `earliest`, `latest`, `max`, `median`, `min`, `most_frequent`, `sum`. | | aggregation | Object 2 | string | Percentile aggregation. | | compute | metric [*required*] | enum | Metric for retention compute. Allowed enum values: `__dd.retention`, `__dd.retention_rate`. | | | data_source [*required*] | enum | Data source for retention queries. Allowed enum values: `product_analytics_retention`. | | | group_by | [object] | Group by configuration. | | group_by | facet [*required*] | string | Facet to group by. | | group_by | limit | int64 | Maximum number of groups. | | group_by | should_exclude_missing | boolean | Whether to exclude missing values. | | group_by | sort | object | Sort configuration for retention group by. | | sort | order | enum | Widget sorting methods. Allowed enum values: `asc`, `desc`. | | group_by | source | string | Source field. | | group_by | target [*required*] | enum | Target for retention group by. Allowed enum values: `cohort`, `return_period`. | | | name [*required*] | string | Name of the query for use in formulas. | | | search [*required*] | object | Search configuration for retention queries. | | search | cohort_criteria [*required*] | object | Cohort criteria for retention queries. | | cohort_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | cohort_criteria | time_interval [*required*] | object | Time interval for cohort criteria. | | time_interval | type [*required*] | enum | Type of time interval for cohort criteria. Allowed enum values: `calendar`. | | time_interval | value [*required*] | object | Calendar interval definition. | | search | filters | object | Filters for retention queries. | | filters | audience_filters | object | Product Analytics/RUM audience filters. | | audience_filters | accounts | [object] | | | audience_filters | filter_condition | string | An optional filter condition applied to the audience subquery. | | audience_filters | segments | [object] | | | audience_filters | users | [object] | | | filters | string_filter | string | String filter. | | search | retention_entity [*required*] | enum | Entity to track for retention. Allowed enum values: `@usr.id`, `@account.id`. | | search | return_condition [*required*] | enum | Condition for counting user return. Allowed enum values: `conversion_on`, `conversion_on_or_after`. | | search | return_criteria | object | Return criteria for retention queries. | | return_criteria | base_query [*required*] | object | Base query for Product Analytics. | | base_query | data_source [*required*] | enum | Data source for Product Analytics event queries. Allowed enum values: `product_analytics`. | | base_query | search [*required*] | object | Search configuration for Product Analytics event query. | | return_criteria | time_interval | object | Time interval for return criteria. | | time_interval | type [*required*] | enum | Type of time interval for return criteria. Allowed enum values: `fixed`. | | time_interval | unit [*required*] | enum | Unit of time for retention return criteria interval. Allowed enum values: `day`, `week`, `month`. | | time_interval | value [*required*] | double | Value of the time interval. | | Object 4 | query | | Query definition for Distribution Widget Histogram Request | | query | | object | A formula and functions metrics query. | | | aggregator | enum | The aggregation methods available for metrics queries. Allowed enum values: `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for metrics queries. Allowed enum values: `metrics`. | | | name [*required*] | string | Name of the query for use in formulas. | | | query [*required*] | string | Metrics query definition. | | | 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 | Object 2 | object | A formula and functions events query. | | Object 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`, `max`, `avg`. | | compute | interval | int64 | A time interval in milliseconds. | | compute | metric | string | Measurable attribute to compute. | | Object 2 | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | Object 2 | data_source [*required*] | enum | Data source for event platform-based queries. Allowed enum values: `logs`, `spans`, `network`, `network_device_flows`, `rum`, `security_signals`, `profiles`, `audit`, `events`, `ci_tests`, `ci_pipelines`, `incident_analytics`, `product_analytics`, `on_call_events`, `errors`, `llm_observability`. | | Object 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 | Object 1 | [object] | List of objects used to group by. | | Object 1 | facet [*required*] | string | Event facet. | | Object 1 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | group_by | Object 2 | object | Flat group by configuration using multiple event facet fields. | | Object 2 | fields [*required*] | [string] | List of event facets to group by. | | Object 2 | limit | int64 | Number of groups to return. | | Object 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`, `max`, `avg`. | | sort | metric | string | Metric used for sorting group by results. | | sort | order | enum | Direction of sort. Allowed enum values: `asc`, `desc`. Default: `desc`. | | Object 2 | indexes | [string] | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | | Object 2 | name [*required*] | string | Name of the query for use in formulas. | | Object 2 | search | object | Search options. | | search | query [*required*] | string | Events search string. | | Object 2 | storage | string | Option for storage location. Feature in Private Beta. | | query | | object | **DEPRECATED**: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead. | | | cross_org_uuids | [string] | The source organization UUID for cross organization queries. Feature in Private Beta. | | | data_source [*required*] | enum | Data source for APM resource stats queries. Allowed enum values: `apm_resource_stats`. | | | env [*required*] | string | APM environment. | | | group_by | [string] | Array of fields to group results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_name | string | Name of operation on service. | | | 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.md#add-a-second-primary-tag-in-datadog) | | | primary_tag_value | string | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | | | resource_name | string | APM resource name. | | | service [*required*] | string | APM service name. | | | 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`, `latency_p99`. | | query | | object | A formula and functions APM metrics query. | | | data_source [*required*] | enum | Data source for APM metrics queries. Allowed enum values: `apm_metrics`. | | | group_by | [string] | Optional fields to group the query results by. | | | name [*required*] | string | Name of this query to use in formulas. | | | operation_mode | string | Optional operation mode to aggregate across operation names. | | | operation_name | string | Name of operation on service. If not provided, the primary operation name is used. | | | peer_tags | [string] | Tags to query for a specific downstream entity (peer.service, peer.db_instance, peer.s3, peer.s3.bucket, etc.). | | | query_filter | string | Additional filters for the query using metrics query syntax (e.g., env, primary_tag). | | | resource_hash | string | The hash of a specific resource to filter by. | | | resource_name | string | The full name of a specific resource to filter by. | | | service | string | APM service name. | | | 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`. | | | 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`, `latency_p999`, `latency_distribution`, `hits`, `hits_per_second`, `total_time`, `apdex`. | | Object 4 | request_type | enum | Distribution of point values for distribution metrics. Renders a histogram of raw metric data points. Allowed enum values: `histogram`. | | Object 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`. | | Object 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.md#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. | | Object 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.md#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. | | Object 4 | style | object | Widget style definition. | | style | palette | string | Color palette to apply to the widget. | | | specification [*required*] | object | Vega or Vega-Lite specification for custom visualization rendering. See 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`. | | | time | | Time setting for the widget. | | time | Object 1 | object | Wrapper for live span | | Object 1 | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | Object 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`, `1mo`, `3mo`, `6mo`, `week_to_date`, `month_to_date`, `1y`, `alert`. | | time | | object | Used for arbitrary live span times, such as 17 minutes or 6 hours. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | type [*required*] | enum | Type "live" denotes a live span in the new format. Allowed enum values: `live`. | | | unit [*required*] | enum | Unit of the time span. Allowed enum values: `minute`, `hour`, `day`, `week`, `month`, `year`. | | | value [*required*] | int64 | Value of the time span. | | time | | object | Used for fixed span times, such as 'March 1 to March 7'. | | | from [*required*] | int64 | Start time in milliseconds since epoch. | | | hide_incomplete_cost_data | boolean | Whether to hide incomplete cost data in the widget. | | | to [*required*] | int64 | End time in milliseconds since epoch. | | | type [*required*] | enum | Type "fixed" denotes a fixed span. Allowed enum values: `fixed`. | | | title | string | Title of the widget. | | | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | | title_size | string | Size of the title. | | | type [*required*] | enum | Type of the wildcard widget. Allowed enum values: `wildcard`. Default: `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 label="Example" %} ```json { "author_handle": "test@datadoghq.com", "author_name": "John Doe", "created_at": "2019-09-19T10:00:00.000Z", "default_timeframe": { "type": "live", "unit": "minute", "value": 4 }, "description": "string", "experience_type": "default", "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 %} {% /tabs %} {% /tab %} {% tab label="403" %} Authentication Error {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Item Not Found {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export dashboard_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v1/dashboard/${dashboard_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```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()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```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(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```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() configuration.access_token = environ["DD_BEARER_TOKEN"] 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get a dashboard returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get a dashboard returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}