--- title: Get a notebook description: Get a notebook using the specified notebook ID. breadcrumbs: Docs > API > Get a notebook --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get a notebook ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/notebooks/{notebook_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/notebooks/{notebook_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/notebooks/{notebook_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/notebooks/{notebook_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/notebooks/{notebook_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/notebooks/{notebook_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/notebooks/{notebook_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/notebooks/{notebook_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/notebooks/{notebook_id} | ### Overview Get a notebook using the specified notebook ID. This endpoint requires the `notebooks_read` permission. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------- | ------------------------------------------------- | | notebook_id [*required*] | integer | Unique ID, assigned when you create the notebook. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} The description of a notebook response. | Parent field | Field | Type | Description | | ----------------------------------------- | ----------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | object | The data for a notebook. | | data | attributes [*required*] | object | The attributes of a notebook. | | attributes | author | object | Attributes of user object returned by the API. | | author | created_at | date-time | Creation time of the user. | | author | disabled | boolean | Whether the user is disabled. | | author | email | string | Email of the user. | | author | handle | string | Handle of the user. | | author | icon | string | URL of the user's icon. | | author | name | string | Name of the user. | | author | status | string | Status of the user. | | author | title | string | Title of the user. | | author | verified | boolean | Whether the user is verified. | | attributes | cells [*required*] | [object] | List of cells to display in the notebook. | | cells | attributes [*required*] | | The attributes of a notebook cell response. Valid cell types are `markdown`, `timeseries`, `toplist`, `heatmap`, `distribution`, `log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets.md) | | attributes | Object 1 | object | The attributes of a notebook `markdown` cell. | | Object 1 | definition [*required*] | object | Text in a notebook is formatted with [Markdown](https://daringfireball.net/projects/markdown/), which enables the use of headings, subheadings, links, images, lists, and code blocks. | | definition | text [*required*] | string | The markdown content. | | definition | type [*required*] | enum | Type of the markdown cell. Allowed enum values: `markdown`. Default: `markdown`. | | attributes | Object 2 | object | The attributes of a notebook `timeseries` cell. | | Object 2 | definition [*required*] | object | The timeseries visualization allows you to display the evolution of one or more metrics, log events, or Indexed Spans over time. | | definition | 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`. | | definition | description | string | The description of the widget. | | definition | 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. | | definition | legend_columns | [string] | Columns displayed in the legend. | | definition | legend_layout | enum | Layout of the legend. Allowed enum values: `auto`, `horizontal`, `vertical`. | | definition | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | definition | 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). | | definition | 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. | | 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. | | 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. | | 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. | | 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. | | definition | 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`. | | definition | show_legend | boolean | (screenboard only) Show the legend for this widget. | | definition | 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`. | | definition | title | string | Title of your widget. | | definition | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | definition | title_size | string | Size of the title. | | definition | type [*required*] | enum | Type of the timeseries widget. Allowed enum values: `timeseries`. Default: `timeseries`. | | definition | 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`. | | Object 2 | graph_size | enum | The size of the graph. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | Object 2 | split_by | object | Object describing how to split the graph to display multiple visualizations per request. | | split_by | keys [*required*] | [string] | Keys to split on. | | split_by | tags [*required*] | [string] | Tags to split on. | | Object 2 | time | object | Timeframe for the notebook cell. When 'null', the notebook global time is used. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | attributes | Object 3 | object | The attributes of a notebook `toplist` cell. | | Object 3 | definition [*required*] | 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. | | definition | 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`. | | definition | description | string | The description of the widget. | | definition | 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. | | 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. | | 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. | | 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. | | 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. | | definition | 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`. | | definition | 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`. | | definition | title | string | Title of your widget. | | definition | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | definition | title_size | string | Size of the title. | | definition | type [*required*] | enum | Type of the top list widget. Allowed enum values: `toplist`. Default: `toplist`. | | Object 3 | graph_size | enum | The size of the graph. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | Object 3 | split_by | object | Object describing how to split the graph to display multiple visualizations per request. | | split_by | keys [*required*] | [string] | Keys to split on. | | split_by | tags [*required*] | [string] | Tags to split on. | | Object 3 | time | object | Timeframe for the notebook cell. When 'null', the notebook global time is used. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | attributes | Object 4 | object | The attributes of a notebook `heatmap` cell. | | Object 4 | definition [*required*] | 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. | | definition | 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`. | | definition | description | string | The description of the widget. | | definition | 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. | | definition | legend_size | string | Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". | | definition | 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). | | definition | 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. | | 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. | | 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. | | 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. | | 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. | | definition | show_legend | boolean | Whether or not to display the legend on this widget. | | definition | 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`. | | definition | title | string | Title of the widget. | | definition | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | definition | title_size | string | Size of the title. | | definition | type [*required*] | enum | Type of the heat map widget. Allowed enum values: `heatmap`. Default: `heatmap`. | | definition | 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). | | definition | 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`. | | Object 4 | graph_size | enum | The size of the graph. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | Object 4 | split_by | object | Object describing how to split the graph to display multiple visualizations per request. | | split_by | keys [*required*] | [string] | Keys to split on. | | split_by | tags [*required*] | [string] | Tags to split on. | | Object 4 | time | object | Timeframe for the notebook cell. When 'null', the notebook global time is used. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | attributes | Object 5 | object | The attributes of a notebook `distribution` cell. | | Object 5 | definition [*required*] | 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. | | definition | 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`. | | definition | description | string | The description of the widget. | | definition | legend_size | string | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | definition | 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). | | definition | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | 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. | | definition | show_legend | boolean | **DEPRECATED**: (Deprecated) The widget legend was replaced by a tooltip and sidebar. | | definition | 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`. | | definition | title | string | Title of the widget. | | definition | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | definition | title_size | string | Size of the title. | | definition | type [*required*] | enum | Type of the distribution widget. Allowed enum values: `distribution`. Default: `distribution`. | | definition | 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`. | | definition | 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`. | | Object 5 | graph_size | enum | The size of the graph. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | Object 5 | split_by | object | Object describing how to split the graph to display multiple visualizations per request. | | split_by | keys [*required*] | [string] | Keys to split on. | | split_by | tags [*required*] | [string] | Tags to split on. | | Object 5 | time | object | Timeframe for the notebook cell. When 'null', the notebook global time is used. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | attributes | Object 6 | object | The attributes of a notebook `log_stream` cell. | | Object 6 | definition [*required*] | object | The Log Stream displays a log flow matching the defined query. | | definition | columns | [string] | Which columns to display on the widget. | | definition | description | string | The description of the widget. | | definition | indexes | [string] | An array of index names to query in the stream. Use [] to query all indexes at once. | | definition | logset | string | **DEPRECATED**: ID of the log set to use. | | definition | message_display | enum | Amount of log lines to display Allowed enum values: `inline`, `expanded-md`, `expanded-lg`. | | definition | query | string | Query to filter the log stream with. | | definition | show_date_column | boolean | Whether to show the date column or not | | definition | show_message_column | boolean | Whether to show the message column or not | | definition | 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`. | | definition | 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`. | | definition | title | string | Title of the widget. | | definition | title_align | enum | How to align the text on the widget. Allowed enum values: `center`, `left`, `right`. | | definition | title_size | string | Size of the title. | | definition | type [*required*] | enum | Type of the log stream widget. Allowed enum values: `log_stream`. Default: `log_stream`. | | Object 6 | graph_size | enum | The size of the graph. Allowed enum values: `xs`, `s`, `m`, `l`, `xl`. | | Object 6 | time | object | Timeframe for the notebook cell. When 'null', the notebook global time is used. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | cells | id [*required*] | string | Notebook cell ID. | | cells | type [*required*] | enum | Type of the Notebook Cell resource. Allowed enum values: `notebook_cells`. Default: `notebook_cells`. | | attributes | created | date-time | UTC time stamp for when the notebook was created. Read-only. | | attributes | metadata | object | Metadata associated with the notebook. | | metadata | is_template | boolean | Whether or not the notebook is a template. Default: `false`. | | metadata | take_snapshots | boolean | Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. Default: `false`. | | metadata | type | enum | Metadata type of the notebook. Allowed enum values: `postmortem`, `runbook`, `investigation`, `documentation`, `report`. | | attributes | modified | date-time | UTC time stamp for when the notebook was last modified. Read-only. | | attributes | name [*required*] | string | The name of the notebook. | | attributes | status | enum | Publication status of the notebook. For now, always "published". Allowed enum values: `published`. Default: `published`. | | attributes | template_variables | [object] | List of template variables for this notebook. | | template_variables | available_values | [string] | The list of values that the template variable drop-down is limited to. | | template_variables | available_values_query | | Query used to dynamically populate the list of available values for the template variable. | | available_values_query | Object 1 | object | Available values query for logs, RUM, or spans data sources. | | Object 1 | data_source [*required*] | string | The data source for the query. Must be one of `logs`, `rum`, or `spans`. | | Object 1 | group_by [*required*] | [object] | Group-by fields for the query. | | group_by | facet [*required*] | string | The facet name to group by. | | Object 1 | search [*required*] | object | Search parameters for an available values query. | | search | query [*required*] | string | The search query string. | | available_values_query | Object 2 | object | Available values query for the metrics data source. | | Object 2 | data_source [*required*] | string | The data source for the query. Must be `metrics`. | | Object 2 | query [*required*] | string | The metrics query string. | | template_variables | data_source_mappings | object | Mapping of data source names to template variable values. | | additionalProperties | | string | The value for the given data source. | | template_variables | default | string | **DEPRECATED**: (deprecated) The default value for the template variable on notebook load. Cannot be used in conjunction with `defaults`. | | template_variables | defaults | [string] | One or many default values for the template variable. Cannot be used in conjunction with `default`. | | template_variables | name [*required*] | string | The name of the variable. | | template_variables | placement | string | The placement of the template variable in the notebook. | | 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 the template variable. | | attributes | time [*required*] | | Notebook global timeframe. | | time | Object 1 | object | Relative timeframe. | | Object 1 | live_span [*required*] | 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 2 | object | Absolute timeframe. | | Object 2 | end [*required*] | date-time | The end time. | | Object 2 | live | boolean | Indicates whether the timeframe should be shifted to end at the current time. | | Object 2 | start [*required*] | date-time | The start time. | | data | id [*required*] | int64 | Unique notebook ID, assigned when you create the notebook. Read-only. | | data | type [*required*] | enum | Type of the Notebook resource. Allowed enum values: `notebooks`. Default: `notebooks`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "author": { "created_at": "2019-09-19T10:00:00.000Z", "disabled": false, "email": "string", "handle": "string", "icon": "string", "name": "string", "status": "string", "title": "string", "verified": false }, "cells": [ { "attributes": { "definition": { "requests": [ { "display_type": "line", "q": "avg:system.load.1{*}", "style": { "line_type": "solid", "line_width": "normal", "palette": "dog_classic" } } ], "show_legend": true, "type": "timeseries", "yaxis": { "scale": "linear" } }, "graph_size": "m", "split_by": { "keys": [], "tags": [] }, "time": null }, "id": "abcd1234", "type": "notebook_cells" } ], "created": "2021-02-24T23:14:15.173964+00:00", "metadata": { "is_template": false, "take_snapshots": false, "type": "investigation" }, "modified": "2021-02-24T23:15:23.274966+00:00", "name": "Example Notebook", "status": "published", "template_variables": [ { "available_values": [ "my-host", "host1", "host2" ], "available_values_query": { "data_source": "logs", "group_by": [ { "facet": "host" } ], "search": { "query": "service:web" } }, "data_source_mappings": { "": "string" }, "default": "my-host", "defaults": [ "my-host-1", "my-host-2" ], "name": "host1", "placement": "global", "prefix": "host", "type": "tag" } ], "time": { "live_span": "5m" } }, "id": 123456, "type": "notebooks" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% 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="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" %} 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 notebook_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/notebooks/${notebook_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get a notebook returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "strconv" "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 "notebook" in the system NotebookDataID, _ := strconv.ParseInt(os.Getenv("NOTEBOOK_DATA_ID"), 10, 64) 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.NewNotebooksApi(apiClient) resp, r, err := api.GetNotebook(ctx, NotebookDataID) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `NotebooksApi.GetNotebook`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `NotebooksApi.GetNotebook`:\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 notebook returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.NotebooksApi; import com.datadog.api.client.v1.model.NotebookResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); NotebooksApi apiInstance = new NotebooksApi(defaultClient); // there is a valid "notebook" in the system Long NOTEBOOK_DATA_ID = Long.parseLong(System.getenv("NOTEBOOK_DATA_ID")); try { NotebookResponse result = apiInstance.getNotebook(NOTEBOOK_DATA_ID); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NotebooksApi#getNotebook"); 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 notebook returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.notebooks_api import NotebooksApi # there is a valid "notebook" in the system NOTEBOOK_DATA_ID = environ["NOTEBOOK_DATA_ID"] configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = NotebooksApi(api_client) response = api_instance.get_notebook( notebook_id=int(NOTEBOOK_DATA_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 notebook returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::NotebooksAPI.new # there is a valid "notebook" in the system NOTEBOOK_DATA_ID = ENV["NOTEBOOK_DATA_ID"] p api_instance.get_notebook(NOTEBOOK_DATA_ID.to_i) ``` #### 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 notebook returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_notebooks::NotebooksAPI; #[tokio::main] async fn main() { // there is a valid "notebook" in the system let notebook_data_id: i64 = std::env::var("NOTEBOOK_DATA_ID").unwrap().parse().unwrap(); let configuration = datadog::Configuration::new(); let api = NotebooksAPI::with_config(configuration); let resp = api.get_notebook(notebook_data_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 notebook 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.NotebooksApi(configuration); // there is a valid "notebook" in the system const NOTEBOOK_DATA_ID = parseInt(process.env.NOTEBOOK_DATA_ID as string); const params: v1.NotebooksApiGetNotebookRequest = { notebookId: NOTEBOOK_DATA_ID, }; apiInstance .getNotebook(params) .then((data: v1.NotebookResponse) => { 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 %} {% /tabs %}