From 6d1d03920311567722ec3042641f14a49de4738e Mon Sep 17 00:00:00 2001 From: "david.leonard" Date: Tue, 11 Jan 2022 16:24:01 -0500 Subject: [PATCH 1/4] Implement support for sunburst widget in Terraform --- datadog/resource_datadog_dashboard.go | 386 ++ .../TestAccDatadogDashboardSunburst.freeze | 1 + .../TestAccDatadogDashboardSunburst.yaml | 236 + ...tAccDatadogDashboardSunburst_import.freeze | 1 + ...estAccDatadogDashboardSunburst_import.yaml | 236 + datadog/tests/provider_test.go | 1 + ...esource_datadog_dashboard_sunburst_test.go | 102 + docs/resources/dashboard.md | 4454 +++++++++++------ 8 files changed, 3845 insertions(+), 1572 deletions(-) create mode 100644 datadog/tests/cassettes/TestAccDatadogDashboardSunburst.freeze create mode 100644 datadog/tests/cassettes/TestAccDatadogDashboardSunburst.yaml create mode 100644 datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.freeze create mode 100644 datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.yaml create mode 100644 datadog/tests/resource_datadog_dashboard_sunburst_test.go diff --git a/datadog/resource_datadog_dashboard.go b/datadog/resource_datadog_dashboard.go index 0289c956f..68dfb8ee5 100644 --- a/datadog/resource_datadog_dashboard.go +++ b/datadog/resource_datadog_dashboard.go @@ -825,6 +825,15 @@ func getNonGroupWidgetSchema() map[string]*schema.Schema { Schema: getServiceLevelObjectiveDefinitionSchema(), }, }, + "sunburst_definition": { + Type: schema.TypeList, + Optional: true, + MaxItems: 1, + Description: "The definition for a Sunburst widget", + Elem: &schema.Resource{ + Schema: getSunburstDefinitionschema(), + }, + }, "timeseries_definition": { Type: schema.TypeList, Optional: true, @@ -968,6 +977,10 @@ func buildDatadogWidget(terraformWidget map[string]interface{}) (*datadogV1.Widg if serviceLevelObjectiveDefinition, ok := def[0].(map[string]interface{}); ok { definition = datadogV1.SLOWidgetDefinitionAsWidgetDefinition(buildDatadogServiceLevelObjectiveDefinition(serviceLevelObjectiveDefinition)) } + } else if def, ok := terraformWidget["sunburst_definition"].([]interface{}); ok && len(def) > 0 { + if sunburstDefinition, ok := def[0].(map[string]interface{}); ok { + definition = datadogV1.SunburstWidgetDefinitionAsWidgetDefinition(buildDatadogSunburstDefinition(sunburstDefinition)) + } } else if def, ok := terraformWidget["timeseries_definition"].([]interface{}); ok && len(def) > 0 { if timeseriesDefinition, ok := def[0].(map[string]interface{}); ok { definition = datadogV1.TimeseriesWidgetDefinitionAsWidgetDefinition(buildDatadogTimeseriesDefinition(timeseriesDefinition)) @@ -1113,6 +1126,9 @@ func buildTerraformWidget(datadogWidget datadogV1.Widget, k *utils.ResourceDataK } else if widgetDefinition.SLOWidgetDefinition != nil { terraformDefinition := buildTerraformServiceLevelObjectiveDefinition(*widgetDefinition.SLOWidgetDefinition) terraformWidget["service_level_objective_definition"] = []map[string]interface{}{terraformDefinition} + } else if widgetDefinition.SunburstWidgetDefinition != nil { + terraformDefinition := buildTerraformSunburstDefinition(*widgetDefinition.SunburstWidgetDefinition, k.Add("sunburst_definition.0")) + terraformWidget["sunburst_definition"] = []map[string]interface{}{terraformDefinition} } else if widgetDefinition.TimeseriesWidgetDefinition != nil { terraformDefinition := buildTerraformTimeseriesDefinition(*widgetDefinition.TimeseriesWidgetDefinition, k.Add("timeseries_definition.0")) k.Remove("timeseries_definition.0") @@ -5009,6 +5025,376 @@ func buildTerraformTimeseriesDefinition(datadogDefinition datadogV1.TimeseriesWi return terraformDefinition } +// +// Sunburst Widget Definition helpers +// + +func getSunburstDefinitionschema() map[string]*schema.Schema { + return map[string]*schema.Schema{ + "request": { + Description: "Nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed with the structure below (exactly one of `q`, `log_query` or `rum_query` is required within the `request` block).", + Type: schema.TypeList, + Optional: true, + Elem: &schema.Resource{ + Schema: getSunburstRequestSchema(), + }, + }, + "hide_total": { + Description: "Whether or not to show the total value in the widget.", + Type: schema.TypeBool, + Optional: true, + }, + "legend_inline": { + Description: "Used to configure the inline legend. Cannot be used in conjunction with legend_table.", + Type: schema.TypeList, + Optional: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "type": { + Description: "The type of legend (table or none).", + Type: schema.TypeString, + ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSunburstWidgetLegendInlineAutomaticTypeFromValue), + Required: true, + }, + "hide_value": { + Description: "Whether to hide the values of the groups.", + Type: schema.TypeBool, + Optional: true, + }, + "hide_percent": { + Description: "Whether to hide the percentages of the groups.", + Type: schema.TypeBool, + Optional: true, + }, + }, + }, + }, + "legend_table": { + Description: "Used to configure the table legend. Cannot be used in conjunction with legend_inline.", + Type: schema.TypeList, + Optional: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "type": { + Description: "The type of legend (automatic or inline).", + Type: schema.TypeString, + ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSunburstWidgetLegendTableTypeFromValue), + Required: true, + }, + }, + }, + }, + "title": { + Description: "The title of the widget.", + Type: schema.TypeString, + Optional: true, + }, + "title_size": { + Description: "The size of the widget's title. Default is 16.", + Type: schema.TypeString, + Optional: true, + }, + "title_align": { + Description: "The alignment of the widget's title. One of `left`, `center`, or `right`.", + Type: schema.TypeString, + ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewWidgetTextAlignFromValue), + Optional: true, + }, + "live_span": getWidgetLiveSpanSchema(), + "custom_link": { + Description: "Nested block describing a custom link. Multiple `custom_link` blocks are allowed with the structure below.", + Type: schema.TypeList, + Optional: true, + Elem: &schema.Resource{ + Schema: getWidgetCustomLinkSchema(), + }, + }, + } +} + +func getSunburstRequestSchema() map[string]*schema.Schema { + return map[string]*schema.Schema{ + // A request should implement exactly one of the following type of query + "q": getMetricQuerySchema(), + "apm_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + "log_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + "rum_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + "network_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + "process_query": getProcessQuerySchema(), + "security_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + "audit_query": getApmLogNetworkRumSecurityAuditQuerySchema(), + // "query" and "formula" go together + "query": getFormulaQuerySchema(), + "formula": getFormulaSchema(), + } +} + +func buildDatadogSunburstLegendInline(terraformSunburstLegendInline map[string]interface{}) datadogV1.SunburstWidgetLegend { + datadogSunburstLegendInline := &datadogV1.SunburstWidgetLegendInlineAutomatic{} + if v, ok := terraformSunburstLegendInline["type"].(string); ok && len(v) != 0 { + legendType := datadogV1.SunburstWidgetLegendInlineAutomaticType(terraformSunburstLegendInline["type"].(string)) + datadogSunburstLegendInline.SetType(legendType) + } + + if v, ok := terraformSunburstLegendInline["hide_value"].(bool); ok { + datadogSunburstLegendInline.SetHideValue(v) + } + + if v, ok := terraformSunburstLegendInline["hide_percent"].(bool); ok { + datadogSunburstLegendInline.SetHidePercent(v) + } + + datadogSunburstLegend := datadogV1.SunburstWidgetLegend{} + datadogSunburstLegend.SunburstWidgetLegendInlineAutomatic = datadogSunburstLegendInline + + return datadogSunburstLegend +} + +func buildDatadogSunburstLegendTable(terraformSunburstLegendTable map[string]interface{}) datadogV1.SunburstWidgetLegend { + datadogSunburstLegendTable := &datadogV1.SunburstWidgetLegendTable{} + if v, ok := terraformSunburstLegendTable["type"].(string); ok && len(v) != 0 { + legendType := datadogV1.SunburstWidgetLegendTableType(terraformSunburstLegendTable["type"].(string)) + datadogSunburstLegendTable.SetType(legendType) + } + + datadogSunburstLegend := datadogV1.SunburstWidgetLegend{} + datadogSunburstLegend.SunburstWidgetLegendTable = datadogSunburstLegendTable + + return datadogSunburstLegend +} + +func buildDatadogSunburstDefinition(terraformDefinition map[string]interface{}) *datadogV1.SunburstWidgetDefinition { + datadogDefinition := datadogV1.NewSunburstWidgetDefinitionWithDefaults() + // Required params + terraformRequests := terraformDefinition["request"].([]interface{}) + datadogDefinition.Requests = *buildDatadogSunburstRequests(&terraformRequests) + + // Optional params + if legendInline, ok := terraformDefinition["legend_inline"].([]interface{}); ok && len(legendInline) > 0 { + if v, ok := legendInline[0].(map[string]interface{}); ok && len(v) > 0 { + datadogDefinition.SetLegend(buildDatadogSunburstLegendInline(v)) + } + } + + if legendTable, ok := terraformDefinition["legend_table"].([]interface{}); ok && len(legendTable) > 0 { + if v, ok := legendTable[0].(map[string]interface{}); ok && len(v) > 0 { + datadogDefinition.SetLegend(buildDatadogSunburstLegendTable(v)) + } + } + + if hideTotal, ok := terraformDefinition["hide_total"].(bool); ok && hideTotal { + datadogDefinition.SetHideTotal(hideTotal) + } + + if v, ok := terraformDefinition["custom_link"].([]interface{}); ok && len(v) > 0 { + datadogDefinition.SetCustomLinks(*buildDatadogWidgetCustomLinks(&v)) + } + + if v, ok := terraformDefinition["title"].(string); ok && len(v) != 0 { + datadogDefinition.SetTitle(v) + } + + if v, ok := terraformDefinition["title_size"].(string); ok && len(v) != 0 { + datadogDefinition.SetTitleSize(v) + } + + if v, ok := terraformDefinition["title_align"].(string); ok && len(v) != 0 { + datadogDefinition.SetTitleAlign(datadogV1.WidgetTextAlign(v)) + } + + if ls, ok := terraformDefinition["live_span"].(string); ok && ls != "" { + datadogDefinition.Time = &datadogV1.WidgetTime{ + LiveSpan: datadogV1.WidgetLiveSpan(ls).Ptr(), + } + } + + if v, ok := terraformDefinition["custom_link"].([]interface{}); ok && len(v) > 0 { + datadogDefinition.SetCustomLinks(*buildDatadogWidgetCustomLinks(&v)) + } + + return datadogDefinition +} + +func buildDatadogSunburstRequests(terraformRequests *[]interface{}) *[]datadogV1.SunburstWidgetRequest { + datadogRequests := make([]datadogV1.SunburstWidgetRequest, len(*terraformRequests)) + for i, r := range *terraformRequests { + if r == nil { + continue + } + terraformRequest := r.(map[string]interface{}) + // Build Sunburst request + datadogSunburstRequest := datadogV1.NewSunburstWidgetRequest() + if v, ok := terraformRequest["q"].(string); ok && len(v) != 0 { + datadogSunburstRequest.SetQ(v) + } else if v, ok := terraformRequest["apm_query"].([]interface{}); ok && len(v) > 0 { + apmQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.ApmQuery = buildDatadogApmOrLogQuery(apmQuery) + } else if v, ok := terraformRequest["log_query"].([]interface{}); ok && len(v) > 0 { + logQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.LogQuery = buildDatadogApmOrLogQuery(logQuery) + } else if v, ok := terraformRequest["network_query"].([]interface{}); ok && len(v) > 0 { + networkQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.NetworkQuery = buildDatadogApmOrLogQuery(networkQuery) + } else if v, ok := terraformRequest["rum_query"].([]interface{}); ok && len(v) > 0 { + rumQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.RumQuery = buildDatadogApmOrLogQuery(rumQuery) + } else if v, ok := terraformRequest["security_query"].([]interface{}); ok && len(v) > 0 { + securityQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.SecurityQuery = buildDatadogApmOrLogQuery(securityQuery) + } else if v, ok := terraformRequest["process_query"].([]interface{}); ok && len(v) > 0 { + processQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.ProcessQuery = buildDatadogProcessQuery(processQuery) + } else if v, ok := terraformRequest["audit_query"].([]interface{}); ok && len(v) > 0 { + auditQuery := v[0].(map[string]interface{}) + datadogSunburstRequest.AuditQuery = buildDatadogApmOrLogQuery(auditQuery) + } else if v, ok := terraformRequest["query"].([]interface{}); ok && len(v) > 0 { + queries := make([]datadogV1.FormulaAndFunctionQueryDefinition, len(v)) + for i, q := range v { + query := q.(map[string]interface{}) + if w, ok := query["event_query"].([]interface{}); ok && len(w) > 0 { + queries[i] = buildDatadogEventQuery(w[0].(map[string]interface{})) + } else if w, ok := query["metric_query"].([]interface{}); ok && len(w) > 0 { + queries[i] = buildDatadogMetricQuery(w[0].(map[string]interface{})) + } else if w, ok := query["process_query"].([]interface{}); ok && len(w) > 0 { + queries[i] = buildDatadogFormulaAndFunctionProcessQuery(w[0].(map[string]interface{})) + } + } + datadogSunburstRequest.SetQueries(queries) + datadogSunburstRequest.SetResponseFormat(datadogV1.FormulaAndFunctionResponseFormat("scalar")) + } + if v, ok := terraformRequest["formula"].([]interface{}); ok && len(v) > 0 { + formulas := make([]datadogV1.WidgetFormula, len(v)) + for i, formula := range v { + formulas[i] = buildDatadogFormula(formula.(map[string]interface{})) + } + datadogSunburstRequest.SetFormulas(formulas) + } + datadogRequests[i] = *datadogSunburstRequest + } + return &datadogRequests +} + +func buildTerraformSunburstRequests(datadogSunburstRequests *[]datadogV1.SunburstWidgetRequest, k *utils.ResourceDataKey) *[]map[string]interface{} { + terraformRequests := make([]map[string]interface{}, len(*datadogSunburstRequests)) + for i, datadogRequest := range *datadogSunburstRequests { + terraformRequest := map[string]interface{}{} + if v, ok := datadogRequest.GetQOk(); ok { + terraformRequest["q"] = v + } else if v, ok := datadogRequest.GetApmQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.apm_query.0", i))) + k.Remove(fmt.Sprintf("%d.apm_query.0", i)) + terraformRequest["apm_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetLogQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.log_query.0", i))) + k.Remove(fmt.Sprintf("%d.log_query.0", i)) + terraformRequest["log_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetNetworkQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.network_query.0", i))) + k.Remove(fmt.Sprintf("%d.network_query.0", i)) + terraformRequest["network_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetProcessQueryOk(); ok { + terraformQuery := buildTerraformProcessQuery(*v) + terraformRequest["process_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetRumQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.rum_query.0", i))) + k.Remove(fmt.Sprintf("%d.rum_query.0", i)) + terraformRequest["rum_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetSecurityQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.security_query.0", i))) + k.Remove(fmt.Sprintf("%d.security_query.0", i)) + terraformRequest["security_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetAuditQueryOk(); ok { + terraformQuery := buildTerraformApmOrLogQuery(*v, k.Add(fmt.Sprintf("%d.audit_query.0", i))) + k.Remove(fmt.Sprintf("%d.audit_query.0", i)) + terraformRequest["audit_query"] = []map[string]interface{}{terraformQuery} + } else if v, ok := datadogRequest.GetQueriesOk(); ok { + terraformRequest["query"] = buildTerraformQuery(*v) + } + + if v, ok := datadogRequest.GetFormulasOk(); ok { + terraformRequest["formula"] = buildTerraformFormula(*v) + } + terraformRequests[i] = terraformRequest + } + return &terraformRequests +} + +func buildTerraformSunburstLegendInline(datadogSunburstLegend datadogV1.SunburstWidgetLegend) []map[string]interface{} { + terraformSunburstLegend := map[string]interface{}{} + terraformSunburstLegendInline := datadogSunburstLegend.SunburstWidgetLegendInlineAutomatic + if terraformSunburstLegendInline != nil { + if v, ok := terraformSunburstLegendInline.GetTypeOk(); ok { + terraformSunburstLegend["type"] = v + } + + if v, ok := terraformSunburstLegendInline.GetHideValueOk(); ok { + terraformSunburstLegend["hide_value"] = v + } + + if v, ok := terraformSunburstLegendInline.GetHidePercentOk(); ok { + terraformSunburstLegend["hide_percent"] = v + } + } + + terraformSunburstLegendArray := []map[string]interface{}{terraformSunburstLegend} + return terraformSunburstLegendArray +} + +func buildTerraformSunburstLegendTable(datadogSunburstLegend datadogV1.SunburstWidgetLegend) []map[string]interface{} { + terraformSunburstLegend := map[string]interface{}{} + terraformSunburstLegendTable := datadogSunburstLegend.SunburstWidgetLegendTable + if terraformSunburstLegendTable != nil { + if v, ok := terraformSunburstLegendTable.GetTypeOk(); ok { + terraformSunburstLegend["type"] = v + } + } + + terraformSunburstLegendArray := []map[string]interface{}{terraformSunburstLegend} + return terraformSunburstLegendArray +} + +func buildTerraformSunburstDefinition(datadogDefinition datadogV1.SunburstWidgetDefinition, k *utils.ResourceDataKey) map[string]interface{} { + terraformDefinition := map[string]interface{}{} + // Required params + terraformDefinition["request"] = buildTerraformSunburstRequests(&datadogDefinition.Requests, k.Add("request")) + k.Remove("request") + + if v, ok := datadogDefinition.GetLegendOk(); ok { + // Use `hide_value` as a discriminant to determine which type of legend we are serializing + if _, ok := v.SunburstWidgetLegendInlineAutomatic.GetHideValueOk(); ok { + terraformDefinition["legend_inline"] = buildTerraformSunburstLegendInline(*v) + } else { + terraformDefinition["legend_table"] = buildTerraformSunburstLegendTable(*v) + } + } + + if v, ok := datadogDefinition.GetHideTotalOk(); ok { + terraformDefinition["hide_total"] = v + } + + if v, ok := datadogDefinition.GetCustomLinksOk(); ok { + terraformDefinition["custom_link"] = buildTerraformWidgetCustomLinks(v) + } + + if v, ok := datadogDefinition.GetTitleOk(); ok { + terraformDefinition["title"] = *v + } + + if v, ok := datadogDefinition.GetTitleSizeOk(); ok { + terraformDefinition["title_size"] = *v + } + + if v, ok := datadogDefinition.GetTitleAlignOk(); ok { + terraformDefinition["title_align"] = *v + } + + if v, ok := datadogDefinition.GetTimeOk(); ok { + terraformDefinition["live_span"] = v.GetLiveSpan() + } + + return terraformDefinition +} + func getScatterplotFormulaSchema() *schema.Schema { return &schema.Schema{ Type: schema.TypeList, diff --git a/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.freeze b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.freeze new file mode 100644 index 000000000..045f1fe63 --- /dev/null +++ b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.freeze @@ -0,0 +1 @@ +2022-01-11T16:09:15.467771-05:00 \ No newline at end of file diff --git a/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.yaml b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.yaml new file mode 100644 index 000000000..119605e19 --- /dev/null +++ b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst.yaml @@ -0,0 +1,236 @@ +--- +version: 1 +interactions: +- request: + body: | + {"description":"Created using the Datadog provider in Terraform","id":"","is_read_only":true,"layout_type":"ordered","notify_list":[],"template_variable_presets":[],"template_variables":[],"title":"tf-TestAccDatadogDashboardSunburst-local-1641935355","widgets":[{"definition":{"custom_links":[{"label":"Test Custom Link label","link":"https://app.datadoghq.com/dashboard/lists"}],"legend":{"hide_percent":false,"hide_value":true,"type":"automatic"},"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}],"response_format":"scalar"}],"type":"sunburst"}},{"definition":{"hide_total":true,"legend":{"type":"table"},"requests":[{"queries":[{"compute":{"aggregation":"count"},"data_source":"rum","indexes":["*"],"name":"query1","search":{"query":"abc"}}],"response_format":"scalar"}],"type":"sunburst"}}]} + form: {} + headers: + Accept: + - application/json + Content-Length: + - "957" + Content-Type: + - application/json + Dd-Operation-Id: + - CreateDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard + method: POST + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"g8i-bnr-xup","title":"tf-TestAccDatadogDashboardSunburst-local-1641935355","url":"/dashboard/g8i-bnr-xup/tf-testaccdatadogdashboardsunburst-local-1641935355","created_at":"2022-01-11T21:09:17.624176+00:00","modified_at":"2022-01-11T21:09:17.624176+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":5232427207874989},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":44699149071502}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:17 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/g8i-bnr-xup + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"g8i-bnr-xup","title":"tf-TestAccDatadogDashboardSunburst-local-1641935355","url":"/dashboard/g8i-bnr-xup/tf-testaccdatadogdashboardsunburst-local-1641935355","created_at":"2022-01-11T21:09:17.624176+00:00","modified_at":"2022-01-11T21:09:17.624176+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":5232427207874989},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":44699149071502}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:17 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/g8i-bnr-xup + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"g8i-bnr-xup","title":"tf-TestAccDatadogDashboardSunburst-local-1641935355","url":"/dashboard/g8i-bnr-xup/tf-testaccdatadogdashboardsunburst-local-1641935355","created_at":"2022-01-11T21:09:17.624176+00:00","modified_at":"2022-01-11T21:09:17.624176+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":5232427207874989},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":44699149071502}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:18 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/g8i-bnr-xup + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"g8i-bnr-xup","title":"tf-TestAccDatadogDashboardSunburst-local-1641935355","url":"/dashboard/g8i-bnr-xup/tf-testaccdatadogdashboardsunburst-local-1641935355","created_at":"2022-01-11T21:09:17.624176+00:00","modified_at":"2022-01-11T21:09:17.624176+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":5232427207874989},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":44699149071502}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:18 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - DeleteDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/g8i-bnr-xup + method: DELETE + response: + body: '{"deleted_dashboard_id":"g8i-bnr-xup"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:20 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/g8i-bnr-xup + method: GET + response: + body: '{"errors": ["Dashboard with ID g8i-bnr-xup not found"]}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:20 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 404 Not Found + code: 404 + duration: "" diff --git a/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.freeze b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.freeze new file mode 100644 index 000000000..856f37d84 --- /dev/null +++ b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.freeze @@ -0,0 +1 @@ +2022-01-11T16:09:15.46721-05:00 \ No newline at end of file diff --git a/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.yaml b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.yaml new file mode 100644 index 000000000..1a8f07632 --- /dev/null +++ b/datadog/tests/cassettes/TestAccDatadogDashboardSunburst_import.yaml @@ -0,0 +1,236 @@ +--- +version: 1 +interactions: +- request: + body: | + {"description":"Created using the Datadog provider in Terraform","id":"","is_read_only":true,"layout_type":"ordered","notify_list":[],"template_variable_presets":[],"template_variables":[],"title":"tf-TestAccDatadogDashboardSunburst_import-local-1641935355","widgets":[{"definition":{"custom_links":[{"label":"Test Custom Link label","link":"https://app.datadoghq.com/dashboard/lists"}],"legend":{"hide_percent":false,"hide_value":true,"type":"automatic"},"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}],"response_format":"scalar"}],"type":"sunburst"}},{"definition":{"hide_total":true,"legend":{"type":"table"},"requests":[{"queries":[{"compute":{"aggregation":"count"},"data_source":"rum","indexes":["*"],"name":"query1","search":{"query":"abc"}}],"response_format":"scalar"}],"type":"sunburst"}}]} + form: {} + headers: + Accept: + - application/json + Content-Length: + - "964" + Content-Type: + - application/json + Dd-Operation-Id: + - CreateDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard + method: POST + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"ere-snz-9a3","title":"tf-TestAccDatadogDashboardSunburst_import-local-1641935355","url":"/dashboard/ere-snz-9a3/tf-testaccdatadogdashboardsunburstimport-local-1641935355","created_at":"2022-01-11T21:09:17.637499+00:00","modified_at":"2022-01-11T21:09:17.637499+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":1892201591754608},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":1974817111440031}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:17 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/ere-snz-9a3 + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"ere-snz-9a3","title":"tf-TestAccDatadogDashboardSunburst_import-local-1641935355","url":"/dashboard/ere-snz-9a3/tf-testaccdatadogdashboardsunburstimport-local-1641935355","created_at":"2022-01-11T21:09:17.637499+00:00","modified_at":"2022-01-11T21:09:17.637499+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":1892201591754608},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":1974817111440031}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:17 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/ere-snz-9a3 + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"ere-snz-9a3","title":"tf-TestAccDatadogDashboardSunburst_import-local-1641935355","url":"/dashboard/ere-snz-9a3/tf-testaccdatadogdashboardsunburstimport-local-1641935355","created_at":"2022-01-11T21:09:17.637499+00:00","modified_at":"2022-01-11T21:09:17.637499+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":1892201591754608},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":1974817111440031}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:18 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/ere-snz-9a3 + method: GET + response: + body: '{"notify_list":[],"description":"Created using the Datadog provider in Terraform","author_name":null,"template_variable_presets":[],"template_variables":[],"is_read_only":true,"id":"ere-snz-9a3","title":"tf-TestAccDatadogDashboardSunburst_import-local-1641935355","url":"/dashboard/ere-snz-9a3/tf-testaccdatadogdashboardsunburstimport-local-1641935355","created_at":"2022-01-11T21:09:17.637499+00:00","modified_at":"2022-01-11T21:09:17.637499+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"formulas":[{"alias":"my ff query","formula":"my_query_1 + my_query_2"}],"response_format":"scalar","queries":[{"aggregator":"sum","data_source":"metrics","name":"my_query_1","query":"avg:system.cpu.user{foo:bar} by {env}"}]}],"custom_links":[{"link":"https://app.datadoghq.com/dashboard/lists","label":"Test Custom Link label"}],"type":"sunburst","legend":{"type":"automatic","hide_percent":false,"hide_value":true}},"id":1892201591754608},{"definition":{"requests":[{"response_format":"scalar","queries":[{"search":{"query":"abc"},"data_source":"rum","compute":{"aggregation":"count"},"name":"query1","indexes":["*"]}]}],"type":"sunburst","hide_total":true,"legend":{"type":"table"}},"id":1974817111440031}],"layout_type":"ordered"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:20 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - DeleteDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/ere-snz-9a3 + method: DELETE + response: + body: '{"deleted_dashboard_id":"ere-snz-9a3"}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:20 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 200 OK + code: 200 + duration: "" +- request: + body: "" + form: {} + headers: + Accept: + - application/json + Dd-Operation-Id: + - GetDashboard + User-Agent: + - terraform-provider-datadog/dev (terraform 2.10.0; terraform-cli 1.1.3) datadog-api-client-go/1.7.1+dev (go go1.16.4; os darwin; arch amd64) + url: https://api.datadoghq.com/api/v1/dashboard/ere-snz-9a3 + method: GET + response: + body: '{"errors": ["Dashboard with ID ere-snz-9a3 not found"]}' + headers: + Cache-Control: + - no-cache + Connection: + - keep-alive + Content-Security-Policy: + - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report + Content-Type: + - application/json + Date: + - Tue, 11 Jan 2022 21:09:20 GMT + Pragma: + - no-cache + Strict-Transport-Security: + - max-age=15724800; + Vary: + - Accept-Encoding + X-Content-Type-Options: + - nosniff + X-Frame-Options: + - SAMEORIGIN + status: 404 Not Found + code: 404 + duration: "" diff --git a/datadog/tests/provider_test.go b/datadog/tests/provider_test.go index e91dca2e7..8a6b7e9e0 100644 --- a/datadog/tests/provider_test.go +++ b/datadog/tests/provider_test.go @@ -97,6 +97,7 @@ var testFiles2EndpointTags = map[string]string{ "tests/resource_datadog_dashboard_scatterplot_test": "dashboards", "tests/resource_datadog_dashboard_service_map_test": "dashboards", "tests/resource_datadog_dashboard_slo_test": "dashboards", + "tests/resource_datadog_dashboard_sunburst_test": "dashboards", "tests/resource_datadog_dashboard_test": "dashboards", "tests/resource_datadog_dashboard_timeseries_test": "dashboards", "tests/resource_datadog_dashboard_top_list_test": "dashboards", diff --git a/datadog/tests/resource_datadog_dashboard_sunburst_test.go b/datadog/tests/resource_datadog_dashboard_sunburst_test.go new file mode 100644 index 000000000..e0bd782dc --- /dev/null +++ b/datadog/tests/resource_datadog_dashboard_sunburst_test.go @@ -0,0 +1,102 @@ +package test + +import ( + "testing" +) + +const datadogDashboardSunburstConfig = ` +resource "datadog_dashboard" "sunburst_dashboard" { + title = "{{uniq}}" + description = "Created using the Datadog provider in Terraform" + layout_type = "ordered" + is_read_only = true + widget { + sunburst_definition { + request { + formula { + formula_expression = "my_query_1 + my_query_2" + alias = "my ff query" + } + query { + metric_query { + data_source = "metrics" + query = "avg:system.cpu.user{foo:bar} by {env}" + name = "my_query_1" + aggregator = "sum" + } + } + } + hide_total = false + legend_inline { + type = "automatic" + hide_value = true + hide_percent = false + } + custom_link { + link = "https://app.datadoghq.com/dashboard/lists" + label = "Test Custom Link label" + } + } + } + widget { + sunburst_definition { + request { + query { + event_query { + data_source = "rum" + indexes = ["*"] + name = "query1" + compute { + aggregation = "count" + } + search { + query = "abc" + } + } + } + } + hide_total = true + legend_table { + type = "table" + } + } + } +} +` + +var datadogDashboardSunburstAsserts = []string{ + "description = Created using the Datadog provider in Terraform", + "layout_type = ordered", + "title = {{uniq}}", + "is_read_only = true", + "widget.0.sunburst_definition.0.request.0.formula.0.formula_expression = my_query_1 + my_query_2", + "widget.0.sunburst_definition.0.request.0.formula.0.alias = my ff query", + "widget.0.sunburst_definition.0.request.0.query.0.metric_query.0.data_source = metrics", + "widget.0.sunburst_definition.0.request.0.query.0.metric_query.0.query = avg:system.cpu.user{foo:bar} by {env}", + "widget.0.sunburst_definition.0.request.0.query.0.metric_query.0.name = my_query_1", + "widget.0.sunburst_definition.0.request.0.query.0.metric_query.0.aggregator = sum", + "widget.0.sunburst_definition.0.hide_total = false", + "widget.0.sunburst_definition.0.legend_inline.0.type = automatic", + "widget.0.sunburst_definition.0.legend_inline.0.hide_value = true", + "widget.0.sunburst_definition.0.legend_inline.0.hide_percent = false", + "widget.0.sunburst_definition.0.legend_inline.0.hide_percent = false", + "widget.0.sunburst_definition.0.custom_link.# = 1", + "widget.0.sunburst_definition.0.custom_link.0.label = Test Custom Link label", + "widget.0.sunburst_definition.0.custom_link.0.link = https://app.datadoghq.com/dashboard/lists", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.data_source = rum", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.indexes.# = 1", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.indexes.0 = *", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.name = query1", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.compute.0.aggregation = count", + "widget.1.sunburst_definition.0.request.0.query.0.event_query.0.search.0.query = abc", + "widget.1.sunburst_definition.0.hide_total = true", + "widget.1.sunburst_definition.0.legend_table.0.type = table", +} + +func TestAccDatadogDashboardSunburst(t *testing.T) { + testAccDatadogDashboardWidgetUtil(t, datadogDashboardSunburstConfig, "datadog_dashboard.sunburst_dashboard", datadogDashboardSunburstAsserts) +} + +func TestAccDatadogDashboardSunburst_import(t *testing.T) { + testAccDatadogDashboardWidgetUtilImport(t, datadogDashboardSunburstConfig, "datadog_dashboard.sunburst_dashboard") +} diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index 8cbf68c95..4b1660a45 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -764,6 +764,7 @@ Optional: - **scatterplot_definition** (Block List, Max: 1) The definition for a Scatterplot widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition)) - **service_level_objective_definition** (Block List, Max: 1) The definition for a Service Level Objective widget. (see [below for nested schema](#nestedblock--widget--service_level_objective_definition)) - **servicemap_definition** (Block List, Max: 1) The definition for a Service Map widget. (see [below for nested schema](#nestedblock--widget--servicemap_definition)) +- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget (see [below for nested schema](#nestedblock--widget--sunburst_definition)) - **timeseries_definition** (Block List, Max: 1) The definition for a Timeseries widget. (see [below for nested schema](#nestedblock--widget--timeseries_definition)) - **toplist_definition** (Block List, Max: 1) The definition for a Toplist widget. (see [below for nested schema](#nestedblock--widget--toplist_definition)) - **trace_service_definition** (Block List, Max: 1) The definition for a Trace Service widget. (see [below for nested schema](#nestedblock--widget--trace_service_definition)) @@ -2102,6 +2103,7 @@ Optional: - **scatterplot_definition** (Block List, Max: 1) The definition for a Scatterplot widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--scatterplot_definition)) - **service_level_objective_definition** (Block List, Max: 1) The definition for a Service Level Objective widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--service_level_objective_definition)) - **servicemap_definition** (Block List, Max: 1) The definition for a Service Map widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--servicemap_definition)) +- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition)) - **timeseries_definition** (Block List, Max: 1) The definition for a Timeseries widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition)) - **toplist_definition** (Block List, Max: 1) The definition for a Toplist widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition)) - **trace_service_definition** (Block List, Max: 1) The definition for a Trace Service widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--trace_service_definition)) @@ -6443,28 +6445,23 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition` Optional: -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--custom_link)) -- **event** (Block List) The definition of the event to overlay on the graph. Multiple `event` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--event)) -- **legend_columns** (Set of String) A list of columns to display in the legend. Valid values are `value`, `avg`, `sum`, `min`, `max`. -- **legend_layout** (String) The layout of the legend displayed in the widget. Valid values are `auto`, `horizontal`, `vertical`. -- **legend_size** (String) The size of the legend displayed in the widget. +- **custom_link** (Block List) Nested block describing a custom link. Multiple `custom_link` blocks are allowed with the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--custom_link)) +- **hide_total** (Boolean) Whether or not to show the total value in the widget. +- **legend_inline** (Block List) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_inline)) +- **legend_table** (Block List) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_table)) - **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **marker** (Block List) A nested block describing the marker to use when displaying the widget. The structure of this block is described below. Multiple `marker` blocks are allowed within a given `tile_def` block. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--marker)) -- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `network_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request)) -- **right_yaxis** (Block List, Max: 1) A nested block describing the right Y-Axis Controls. See the `on_right_yaxis` property for which request will use this axis. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--right_yaxis)) -- **show_legend** (Boolean) Whether or not to show the legend on this widget. +- **request** (Block List) Nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed with the structure below (exactly one of `q`, `log_query` or `rum_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request)) - **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). -- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--yaxis)) +- **title_align** (String) The alignment of the widget's title. One of `left`, `center`, or `right`. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title. Default is 16. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.custom_link` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.custom_link` Optional: @@ -6474,53 +6471,45 @@ Optional: - **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.event` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.legend_inline` Required: -- **q** (String) The event query to use in the widget. +- **type** (String) The type of legend (table or inline). Optional: -- **tags_execution** (String) The execution method for multi-value filters. +- **hide_percent** (Boolean) Whether to hide the percentages of the groups. +- **hide_value** (Boolean) Whether to hide the values of the groups. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.marker` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.legend_table` Required: -- **value** (String) A mathematical expression describing the marker, for example: `y > 1`, `-5 < y < 0`, `y = 19`. - -Optional: - -- **display_type** (String) How the marker lines are displayed, options are one of {`error`, `warning`, `info`, `ok`} combined with one of {`dashed`, `solid`, `bold`}. Example: `error dashed`. -- **label** (String) A label for the line or range. +- **type** (String) The type of legend (table or inline). - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request` Optional: -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query)) -- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query)) -- **display_type** (String) How to display the marker lines. Valid values are `area`, `bars`, `line`. -- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query)) -- **metadata** (Block List) Used to define expression aliases. Multiple `metadata` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--metadata)) -- **network_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query)) -- **on_right_yaxis** (Boolean) A Boolean indicating whether the request uses the right or left Y-Axis. -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--process_query)) +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--apm_query)) +- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--audit_query)) +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--formula)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--log_query)) +- **network_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--network_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--process_query)) - **q** (String) The metric query to use for this widget. -- **query** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query)) -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query)) -- **style** (Block List, Max: 1) The style of the widget graph. Exactly one `style` block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--style)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--security_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.apm_query` Required: @@ -6528,13 +6517,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.apm_query.compute_query` Required: @@ -6546,17 +6535,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.apm_query.group_by.sort_query` Required: @@ -6569,8 +6558,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.apm_query.multi_compute` Required: @@ -6583,8 +6572,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.audit_query` Required: @@ -6592,13 +6581,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--audit_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--audit_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--audit_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.audit_query.compute_query` Required: @@ -6610,17 +6599,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.audit_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--audit_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.audit_query.group_by.sort_query` Required: @@ -6633,8 +6622,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.audit_query.multi_compute` Required: @@ -6647,8 +6636,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.formula` Required: @@ -6658,11 +6647,11 @@ Optional: - **alias** (String) An expression alias. - **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula--conditional_formats)) -- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula--limit)) +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--formula--limit)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula.conditional_formats` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.formula.conditional_formats` Required: @@ -6680,8 +6669,8 @@ Optional: - **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula.limit` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.formula.limit` Optional: @@ -6690,8 +6679,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.log_query` Required: @@ -6699,13 +6688,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.log_query.compute_query` Required: @@ -6717,17 +6706,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--log_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.log_query.group_by.sort_query` Required: @@ -6740,8 +6729,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.log_query.multi_compute` Required: @@ -6754,20 +6743,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.metadata` - -Required: - -- **expression** (String) The expression name. - -Optional: - -- **alias_name** (String) The expression alias. - - - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.network_query` Required: @@ -6775,13 +6752,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--network_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--network_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--network_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.network_query.compute_query` Required: @@ -6793,17 +6770,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.network_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--network_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.network_query.group_by.sort_query` Required: @@ -6816,8 +6793,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.network_query.multi_compute` Required: @@ -6830,8 +6807,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.process_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.process_query` Required: @@ -6844,19 +6821,19 @@ Optional: - **search_by** (String) Your chosen search term. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query` Optional: -- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--apm_dependency_stats_query)) -- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--apm_resource_stats_query)) -- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query)) -- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--metric_query)) -- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--process_query)) +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--process_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.apm_dependency_stats_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.apm_dependency_stats_query` Required: @@ -6875,8 +6852,8 @@ Optional: - **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.apm_resource_stats_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.apm_resource_stats_query` Required: @@ -6895,23 +6872,23 @@ Optional: - **resource_name** (String) APM resource. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.event_query` Required: -- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--compute)) +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--event_query--compute)) - **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. - **name** (String) The name of query for use in formulas. Optional: -- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--group_by)) +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--event_query--group_by)) - **indexes** (List of String) An array of index names to query in the stream. -- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--search)) +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--event_query--search)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.event_query.compute` Required: @@ -6923,8 +6900,8 @@ Optional: - **metric** (String) The measurable attribute to compute. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.event_query.group_by` Required: @@ -6933,10 +6910,10 @@ Required: Optional: - **limit** (Number) The number of groups to return. -- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--group_by--sort)) +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--query--event_query--group_by--sort)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.group_by.sort` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.event_query.group_by.sort` Required: @@ -6949,8 +6926,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.search` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.event_query.search` Required: @@ -6958,8 +6935,8 @@ Required: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.metric_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.metric_query` Required: @@ -6972,8 +6949,8 @@ Optional: - **data_source** (String) The data source for metrics queries. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.process_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.query.process_query` Required: @@ -6992,8 +6969,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.rum_query` Required: @@ -7001,13 +6978,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.rum_query.compute_query` Required: @@ -7019,17 +6996,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.rum_query.group_by.sort_query` Required: @@ -7042,8 +7019,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.rum_query.multi_compute` Required: @@ -7056,8 +7033,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.security_query` Required: @@ -7065,13 +7042,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--security_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.security_query.compute_query` Required: @@ -7083,17 +7060,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.group_by` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.security_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request--security_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.security_query.group_by.sort_query` Required: @@ -7106,8 +7083,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.sunburst_definition.request.security_query.multi_compute` Required: @@ -7120,84 +7097,86 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.style` -Optional: -- **line_type** (String) The type of lines displayed. Valid values are `dashed`, `dotted`, `solid`. -- **line_width** (String) The width of line displayed. Valid values are `normal`, `thick`, `thin`. -- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. + +### Nested Schema for `widget.group_definition.widget.timeseries_definition` +Optional: +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--custom_link)) +- **event** (Block List) The definition of the event to overlay on the graph. Multiple `event` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--event)) +- **legend_columns** (Set of String) A list of columns to display in the legend. Valid values are `value`, `avg`, `sum`, `min`, `max`. +- **legend_layout** (String) The layout of the legend displayed in the widget. Valid values are `auto`, `horizontal`, `vertical`. +- **legend_size** (String) The size of the legend displayed in the widget. +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **marker** (Block List) A nested block describing the marker to use when displaying the widget. The structure of this block is described below. Multiple `marker` blocks are allowed within a given `tile_def` block. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--marker)) +- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `network_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request)) +- **right_yaxis** (Block List, Max: 1) A nested block describing the right Y-Axis Controls. See the `on_right_yaxis` property for which request will use this axis. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--right_yaxis)) +- **show_legend** (Boolean) Whether or not to show the legend on this widget. +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). +- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--yaxis)) - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.right_yaxis` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.custom_link` Optional: -- **include_zero** (Boolean) Always include zero or fit the axis to the data range. -- **label** (String) The label of the axis to display on the graph. -- **max** (String) Specify the maximum value to show on the Y-axis. -- **min** (String) Specify the minimum value to show on the Y-axis. -- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.group_definition.widget.timeseries_definition.yaxis` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.event` -Optional: +Required: -- **include_zero** (Boolean) Always include zero or fit the axis to the data range. -- **label** (String) The label of the axis to display on the graph. -- **max** (String) Specify the maximum value to show on the Y-axis. -- **min** (String) Specify the minimum value to show on the Y-axis. -- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. +- **q** (String) The event query to use in the widget. +Optional: +- **tags_execution** (String) The execution method for multi-value filters. - -### Nested Schema for `widget.group_definition.widget.toplist_definition` -Optional: + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.marker` -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--custom_link)) -- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request)) -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). +Required: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.custom_link` +- **value** (String) A mathematical expression describing the marker, for example: `y > 1`, `-5 < y < 0`, `y = 19`. Optional: -- **is_hidden** (Boolean) The flag for toggling context menu link visibility. -- **label** (String) The label for the custom link URL. -- **link** (String) The URL of the custom link. -- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. +- **display_type** (String) How the marker lines are displayed, options are one of {`error`, `warning`, `info`, `ok`} combined with one of {`dashed`, `solid`, `bold`}. Example: `error dashed`. +- **label** (String) A label for the line or range. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request` Optional: -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query)) -- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query)) -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background, depending on a rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--conditional_formats)) -- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--process_query)) +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query)) +- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query)) +- **display_type** (String) How to display the marker lines. Valid values are `area`, `bars`, `line`. +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query)) +- **metadata** (Block List) Used to define expression aliases. Multiple `metadata` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--metadata)) +- **network_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query)) +- **on_right_yaxis** (Boolean) A Boolean indicating whether the request uses the right or left Y-Axis. +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--process_query)) - **q** (String) The metric query to use for this widget. -- **query** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query)) -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query)) -- **style** (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--style)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query)) +- **style** (Block List, Max: 1) The style of the widget graph. Exactly one `style` block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--style)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query` Required: @@ -7205,13 +7184,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.compute_query` Required: @@ -7223,17 +7202,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.group_by.sort_query` Required: @@ -7246,8 +7225,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.apm_query.multi_compute` Required: @@ -7260,8 +7239,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query` Required: @@ -7269,13 +7248,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.compute_query` Required: @@ -7287,17 +7266,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--audit_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.group_by.sort_query` Required: @@ -7310,8 +7289,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.audit_query.multi_compute` Required: @@ -7324,8 +7303,22 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.conditional_formats` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula` + +Required: + +- **formula_expression** (String) A string expression built from queries, formulas, and functions. + +Optional: + +- **alias** (String) An expression alias. +- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--formula--limit)) + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula.conditional_formats` Required: @@ -7343,51 +7336,94 @@ Optional: - **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.formula.limit` + +Optional: + +- **count** (Number) The number of results to return +- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. + + + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query` Required: -- **formula_expression** (String) A string expression built from queries, formulas, and functions. +- **index** (String) The name of the index to query. Optional: -- **alias** (String) An expression alias. -- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula--conditional_formats)) -- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula--limit)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--multi_compute)) +- **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula.conditional_formats` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.compute_query` Required: -- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. -- **palette** (String) The color palette to apply. Valid values are `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`. -- **value** (Number) A value for the comparator. +- **aggregation** (String) The aggregation method. Optional: -- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. -- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. -- **hide_value** (Boolean) Setting this to True hides values. -- **image_url** (String) Displays an image as the background. -- **metric** (String) The metric from the request to correlate with this conditional format. -- **timeframe** (String) Defines the displayed timeframe. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula.limit` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.group_by` Optional: -- **count** (Number) The number of results to return -- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--log_query--group_by--sort_query)) + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.group_by.sort_query` +Required: +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query` +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.log_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.metadata` + +Required: + +- **expression** (String) The expression name. + +Optional: + +- **alias_name** (String) The expression alias. + + + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query` Required: @@ -7395,13 +7431,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.compute_query` Required: @@ -7413,17 +7449,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--network_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.group_by.sort_query` Required: @@ -7436,8 +7472,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.network_query.multi_compute` Required: @@ -7450,8 +7486,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.process_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.process_query` Required: @@ -7464,19 +7500,19 @@ Optional: - **search_by** (String) Your chosen search term. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query` Optional: -- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--apm_dependency_stats_query)) -- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--apm_resource_stats_query)) -- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query)) -- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--metric_query)) -- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--process_query)) +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--process_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.apm_dependency_stats_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.apm_dependency_stats_query` Required: @@ -7495,8 +7531,8 @@ Optional: - **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.apm_resource_stats_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.apm_resource_stats_query` Required: @@ -7515,23 +7551,23 @@ Optional: - **resource_name** (String) APM resource. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query` Required: -- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--compute)) +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--compute)) - **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. - **name** (String) The name of query for use in formulas. Optional: -- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--group_by)) +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--group_by)) - **indexes** (List of String) An array of index names to query in the stream. -- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--search)) +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--search)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.compute` Required: @@ -7543,8 +7579,8 @@ Optional: - **metric** (String) The measurable attribute to compute. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.group_by` Required: @@ -7553,10 +7589,10 @@ Required: Optional: - **limit** (Number) The number of groups to return. -- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--group_by--sort)) +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--query--event_query--group_by--sort)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.group_by.sort` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.group_by.sort` Required: @@ -7569,8 +7605,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.search` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.event_query.search` Required: @@ -7578,8 +7614,8 @@ Required: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.metric_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.metric_query` Required: @@ -7592,8 +7628,8 @@ Optional: - **data_source** (String) The data source for metrics queries. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.process_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.query.process_query` Required: @@ -7612,8 +7648,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query` Required: @@ -7621,13 +7657,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.compute_query` Required: @@ -7639,17 +7675,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.group_by.sort_query` Required: @@ -7662,8 +7698,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.rum_query.multi_compute` Required: @@ -7676,8 +7712,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query` Required: @@ -7685,13 +7721,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.compute_query` Required: @@ -7703,17 +7739,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.group_by` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--request--security_query--group_by--sort_query)) - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.group_by.sort_query` Required: @@ -7726,8 +7762,8 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.security_query.multi_compute` Required: @@ -7740,76 +7776,56 @@ Optional: - -### Nested Schema for `widget.group_definition.widget.toplist_definition.request.style` + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.request.style` Optional: +- **line_type** (String) The type of lines displayed. Valid values are `dashed`, `dotted`, `solid`. +- **line_width** (String) The width of line displayed. Valid values are `normal`, `thick`, `thin`. - **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. - - -### Nested Schema for `widget.group_definition.widget.trace_service_definition` - -Required: - -- **env** (String) APM environment. -- **service** (String) APM service. -- **span_name** (String) APM span name + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.right_yaxis` Optional: -- **display_format** (String) The number of columns to display. Valid values are `one_column`, `two_column`, `three_column`. -- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **show_breakdown** (Boolean) Whether to show the latency breakdown or not. -- **show_distribution** (Boolean) Whether to show the latency distribution or not. -- **show_errors** (Boolean) Whether to show the error metrics or not. -- **show_hits** (Boolean) Whether to show the hits metrics or not -- **show_latency** (Boolean) Whether to show the latency metrics or not. -- **show_resource_list** (Boolean) Whether to show the resource list or not. -- **size_format** (String) The size of the widget. Valid values are `small`, `medium`, `large`. -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). - - - -### Nested Schema for `widget.group_definition.widget.widget_layout` +- **include_zero** (Boolean) Always include zero or fit the axis to the data range. +- **label** (String) The label of the axis to display on the graph. +- **max** (String) Specify the maximum value to show on the Y-axis. +- **min** (String) Specify the minimum value to show on the Y-axis. +- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. -Required: -- **height** (Number) The height of the widget. -- **width** (Number) The width of the widget. -- **x** (Number) The position of the widget on the x (horizontal) axis. Should be greater than or equal to 0. -- **y** (Number) The position of the widget on the y (vertical) axis. Should be greater than or equal to 0. + +### Nested Schema for `widget.group_definition.widget.timeseries_definition.yaxis` Optional: -- **is_column_break** (Boolean) Whether the widget should be the first one on the second column in high density or not. Only for the new dashboard layout and only one widget in the dashboard should have this property set to `true`. - +- **include_zero** (Boolean) Always include zero or fit the axis to the data range. +- **label** (String) The label of the axis to display on the graph. +- **max** (String) Specify the maximum value to show on the Y-axis. +- **min** (String) Specify the minimum value to show on the Y-axis. +- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. - -### Nested Schema for `widget.heatmap_definition` + +### Nested Schema for `widget.group_definition.widget.toplist_definition` Optional: -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--custom_link)) -- **event** (Block List) The definition of the event to overlay on the graph. Multiple `event` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--event)) -- **legend_size** (String) The size of the legend displayed in the widget. +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--custom_link)) - **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--heatmap_definition--request)) -- **show_legend** (Boolean) Whether or not to show the legend on this widget. +- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request)) - **title** (String) The title of the widget. - **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. - **title_size** (String) The size of the widget's title (defaults to 16). -- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--yaxis)) - -### Nested Schema for `widget.heatmap_definition.custom_link` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.custom_link` Optional: @@ -7819,33 +7835,25 @@ Optional: - **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.heatmap_definition.event` - -Required: - -- **q** (String) The event query to use in the widget. - -Optional: - -- **tags_execution** (String) The execution method for multi-value filters. - - - -### Nested Schema for `widget.heatmap_definition.request` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request` Optional: -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--process_query)) +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query)) +- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query)) +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background, depending on a rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--conditional_formats)) +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--process_query)) - **q** (String) The metric query to use for this widget. -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query)) -- **style** (Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--style)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query)) +- **style** (Block List, Max: 1) Define request for the widget's style. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--style)) - -### Nested Schema for `widget.heatmap_definition.request.apm_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query` Required: @@ -7853,13 +7861,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.heatmap_definition.request.apm_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.compute_query` Required: @@ -7871,17 +7879,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.heatmap_definition.request.apm_query.group_by` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.heatmap_definition.request.apm_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.group_by.sort_query` Required: @@ -7894,8 +7902,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.apm_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.apm_query.multi_compute` Required: @@ -7908,8 +7916,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.log_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query` Required: @@ -7917,13 +7925,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.heatmap_definition.request.log_query.compute_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.compute_query` Required: @@ -7935,17 +7943,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.heatmap_definition.request.log_query.group_by` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--audit_query--group_by--sort_query)) - -### Nested Schema for `widget.heatmap_definition.request.log_query.group_by.sort_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.group_by.sort_query` Required: @@ -7958,8 +7966,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.log_query.multi_compute` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.audit_query.multi_compute` Required: @@ -7972,35 +7980,683 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.process_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.conditional_formats` Required: -- **metric** (String) Your chosen metric. +- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. +- **palette** (String) The color palette to apply. Valid values are `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`. +- **value** (Number) A value for the comparator. Optional: -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. +- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. +- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. +- **hide_value** (Boolean) Setting this to True hides values. +- **image_url** (String) Displays an image as the background. +- **metric** (String) The metric from the request to correlate with this conditional format. +- **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.heatmap_definition.request.rum_query` + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula` Required: -- **index** (String) The name of the index to query. +- **formula_expression** (String) A string expression built from queries, formulas, and functions. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--multi_compute)) -- **search_query** (String) The search query to use. - - +- **alias** (String) An expression alias. +- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--formula--limit)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula.conditional_formats` + +Required: + +- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. +- **palette** (String) The color palette to apply. Valid values are `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`. +- **value** (Number) A value for the comparator. + +Optional: + +- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. +- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. +- **hide_value** (Boolean) Setting this to True hides values. +- **image_url** (String) Displays an image as the background. +- **metric** (String) The metric from the request to correlate with this conditional format. +- **timeframe** (String) Defines the displayed timeframe. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.formula.limit` + +Optional: + +- **count** (Number) The number of results to return +- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--log_query--group_by--sort_query)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.log_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.process_query` + +Required: + +- **metric** (String) Your chosen metric. + +Optional: + +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query` + +Optional: + +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--process_query)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.apm_dependency_stats_query` + +Required: + +- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **operation_name** (String) Name of operation on service. +- **resource_name** (String) APM resource. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. + +Optional: + +- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. +- **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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.apm_resource_stats_query` + +Required: + +- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. + +Optional: + +- **group_by** (List of String) Array of fields to group results by. +- **operation_name** (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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. +- **resource_name** (String) APM resource. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query` + +Required: + +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--compute)) +- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. +- **name** (String) The name of query for use in formulas. + +Optional: + +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--group_by)) +- **indexes** (List of String) An array of index names to query in the stream. +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--search)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.compute` + +Required: + +- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. + +Optional: + +- **interval** (Number) A time interval in milliseconds. +- **metric** (String) The measurable attribute to compute. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.group_by` + +Required: + +- **facet** (String) The event facet. + +Optional: + +- **limit** (Number) The number of groups to return. +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--query--event_query--group_by--sort)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.group_by.sort` + +Required: + +- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. + +Optional: + +- **metric** (String) The metric used for sorting group by results. +- **order** (String) Direction of sort. Valid values are `asc`, `desc`. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.event_query.search` + +Required: + +- **query** (String) The events search string. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.metric_query` + +Required: + +- **name** (String) The name of the query for use in formulas. +- **query** (String) The metrics query definition. + +Optional: + +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **data_source** (String) The data source for metrics queries. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.query.process_query` + +Required: + +- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. +- **metric** (String) The process metric name. +- **name** (String) The name of query for use in formulas. + +Optional: + +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. +- **limit** (Number) The number of hits to return. +- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. +- **tag_filters** (List of String) An array of tags to filter by. +- **text_filter** (String) The text to use as a filter. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--rum_query--group_by--sort_query)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.rum_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition--request--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.security_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.group_definition.widget.toplist_definition.request.style` + +Optional: + +- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. + + + + + +### Nested Schema for `widget.group_definition.widget.trace_service_definition` + +Required: + +- **env** (String) APM environment. +- **service** (String) APM service. +- **span_name** (String) APM span name + +Optional: + +- **display_format** (String) The number of columns to display. Valid values are `one_column`, `two_column`, `three_column`. +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **show_breakdown** (Boolean) Whether to show the latency breakdown or not. +- **show_distribution** (Boolean) Whether to show the latency distribution or not. +- **show_errors** (Boolean) Whether to show the error metrics or not. +- **show_hits** (Boolean) Whether to show the hits metrics or not +- **show_latency** (Boolean) Whether to show the latency metrics or not. +- **show_resource_list** (Boolean) Whether to show the resource list or not. +- **size_format** (String) The size of the widget. Valid values are `small`, `medium`, `large`. +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). + + + +### Nested Schema for `widget.group_definition.widget.widget_layout` + +Required: + +- **height** (Number) The height of the widget. +- **width** (Number) The width of the widget. +- **x** (Number) The position of the widget on the x (horizontal) axis. Should be greater than or equal to 0. +- **y** (Number) The position of the widget on the y (vertical) axis. Should be greater than or equal to 0. + +Optional: + +- **is_column_break** (Boolean) Whether the widget should be the first one on the second column in high density or not. Only for the new dashboard layout and only one widget in the dashboard should have this property set to `true`. + + + + + +### Nested Schema for `widget.heatmap_definition` + +Optional: + +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--custom_link)) +- **event** (Block List) The definition of the event to overlay on the graph. Multiple `event` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--event)) +- **legend_size** (String) The size of the legend displayed in the widget. +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--heatmap_definition--request)) +- **show_legend** (Boolean) Whether or not to show the legend on this widget. +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). +- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--yaxis)) + + +### Nested Schema for `widget.heatmap_definition.custom_link` + +Optional: + +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. + + + +### Nested Schema for `widget.heatmap_definition.event` + +Required: + +- **q** (String) The event query to use in the widget. + +Optional: + +- **tags_execution** (String) The execution method for multi-value filters. + + + +### Nested Schema for `widget.heatmap_definition.request` + +Optional: + +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--process_query)) +- **q** (String) The metric query to use for this widget. +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query)) +- **style** (Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--style)) + + +### Nested Schema for `widget.heatmap_definition.request.apm_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.heatmap_definition.request.apm_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.heatmap_definition.request.apm_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--apm_query--group_by--sort_query)) + + +### Nested Schema for `widget.heatmap_definition.request.apm_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.heatmap_definition.request.apm_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.heatmap_definition.request.log_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.heatmap_definition.request.log_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.heatmap_definition.request.log_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--log_query--group_by--sort_query)) + + +### Nested Schema for `widget.heatmap_definition.request.log_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.heatmap_definition.request.log_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.heatmap_definition.request.process_query` + +Required: + +- **metric** (String) Your chosen metric. + +Optional: + +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. + + + +### Nested Schema for `widget.heatmap_definition.request.rum_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--multi_compute)) +- **search_query** (String) The search query to use. + + ### Nested Schema for `widget.heatmap_definition.request.rum_query.compute_query` Required: @@ -8013,17 +8669,498 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.heatmap_definition.request.rum_query.group_by` + +### Nested Schema for `widget.heatmap_definition.request.rum_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--group_by--sort_query)) + + +### Nested Schema for `widget.heatmap_definition.request.rum_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.heatmap_definition.request.rum_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.heatmap_definition.request.security_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.heatmap_definition.request.security_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.heatmap_definition.request.security_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.heatmap_definition.request.security_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.heatmap_definition.request.security_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.heatmap_definition.request.style` + +Optional: + +- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. + + + + +### Nested Schema for `widget.heatmap_definition.yaxis` + +Optional: + +- **include_zero** (Boolean) Always include zero or fit the axis to the data range. +- **label** (String) The label of the axis to display on the graph. +- **max** (String) Specify the maximum value to show on the Y-axis. +- **min** (String) Specify the minimum value to show on the Y-axis. +- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. + + + + +### Nested Schema for `widget.hostmap_definition` + +Optional: + +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--custom_link)) +- **group** (List of String) The list of tags to group nodes by. +- **no_group_hosts** (Boolean) A Boolean indicating whether to show ungrouped nodes. +- **no_metric_hosts** (Boolean) A Boolean indicating whether to show nodes with no metrics. +- **node_type** (String) The type of node used. Valid values are `host`, `container`. +- **request** (Block List, Max: 1) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request)) +- **scope** (List of String) The list of tags to filter nodes by. +- **style** (Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--style)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). + + +### Nested Schema for `widget.hostmap_definition.custom_link` + +Optional: + +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. + + + +### Nested Schema for `widget.hostmap_definition.request` + +Optional: + +- **fill** (Block List) The query used to fill the map. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill)) +- **size** (Block List) The query used to size the map. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size)) + + +### Nested Schema for `widget.hostmap_definition.request.fill` + +Optional: + +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--process_query)) +- **q** (String) The metric query to use for this widget. +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query)) + + +### Nested Schema for `widget.hostmap_definition.request.fill.apm_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--group_by--sort_query)) + + +### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.log_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.hostmap_definition.request.fill.log_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.hostmap_definition.request.fill.log_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--group_by--sort_query)) + + +### Nested Schema for `widget.hostmap_definition.request.fill.log_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.log_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.process_query` + +Required: + +- **metric** (String) Your chosen metric. + +Optional: + +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. + + + +### Nested Schema for `widget.hostmap_definition.request.fill.rum_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--group_by--sort_query)) + + +### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.security_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.hostmap_definition.request.fill.security_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.hostmap_definition.request.fill.security_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.hostmap_definition.request.fill.security_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.hostmap_definition.request.fill.security_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + + +### Nested Schema for `widget.hostmap_definition.request.size` + +Optional: + +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--process_query)) +- **q** (String) The metric query to use for this widget. +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query)) + + +### Nested Schema for `widget.hostmap_definition.request.size.apm_query` + +Required: + +- **index** (String) The name of the index to query. + +Optional: + +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--multi_compute)) +- **search_query** (String) The search query to use. + + +### Nested Schema for `widget.hostmap_definition.request.size.apm_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.hostmap_definition.request.size.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.heatmap_definition.request.rum_query.group_by.sort_query` + +### Nested Schema for `widget.hostmap_definition.request.size.apm_query.group_by.sort_query` Required: @@ -8036,8 +9173,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.rum_query.multi_compute` + +### Nested Schema for `widget.hostmap_definition.request.size.apm_query.multi_compute` Required: @@ -8050,8 +9187,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.security_query` + +### Nested Schema for `widget.hostmap_definition.request.size.log_query` Required: @@ -8059,13 +9196,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.heatmap_definition.request.security_query.compute_query` + +### Nested Schema for `widget.hostmap_definition.request.size.log_query.compute_query` Required: @@ -8077,17 +9214,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.heatmap_definition.request.security_query.group_by` + +### Nested Schema for `widget.hostmap_definition.request.size.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--heatmap_definition--request--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--group_by--sort_query)) - -### Nested Schema for `widget.heatmap_definition.request.security_query.group_by.sort_query` + +### Nested Schema for `widget.hostmap_definition.request.size.log_query.group_by.sort_query` Required: @@ -8100,8 +9237,8 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.security_query.multi_compute` + +### Nested Schema for `widget.hostmap_definition.request.size.log_query.multi_compute` Required: @@ -8114,78 +9251,86 @@ Optional: - -### Nested Schema for `widget.heatmap_definition.request.style` + +### Nested Schema for `widget.hostmap_definition.request.size.process_query` + +Required: + +- **metric** (String) Your chosen metric. Optional: -- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. + +### Nested Schema for `widget.hostmap_definition.request.size.rum_query` + +Required: - -### Nested Schema for `widget.heatmap_definition.yaxis` +- **index** (String) The name of the index to query. Optional: -- **include_zero** (Boolean) Always include zero or fit the axis to the data range. -- **label** (String) The label of the axis to display on the graph. -- **max** (String) Specify the maximum value to show on the Y-axis. -- **min** (String) Specify the minimum value to show on the Y-axis. -- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--multi_compute)) +- **search_query** (String) The search query to use. + +### Nested Schema for `widget.hostmap_definition.request.size.rum_query.compute_query` +Required: - -### Nested Schema for `widget.hostmap_definition` +- **aggregation** (String) The aggregation method. Optional: -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--custom_link)) -- **group** (List of String) The list of tags to group nodes by. -- **no_group_hosts** (Boolean) A Boolean indicating whether to show ungrouped nodes. -- **no_metric_hosts** (Boolean) A Boolean indicating whether to show nodes with no metrics. -- **node_type** (String) The type of node used. Valid values are `host`, `container`. -- **request** (Block List, Max: 1) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request)) -- **scope** (List of String) The list of tags to filter nodes by. -- **style** (Block List, Max: 1) The style of the widget graph. One nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--style)) -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.custom_link` + + +### Nested Schema for `widget.hostmap_definition.request.size.rum_query.group_by` Optional: -- **is_hidden** (Boolean) The flag for toggling context menu link visibility. -- **label** (String) The label for the custom link URL. -- **link** (String) The URL of the custom link. -- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--group_by--sort_query)) + +### Nested Schema for `widget.hostmap_definition.request.size.rum_query.group_by.sort_query` - -### Nested Schema for `widget.hostmap_definition.request` +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **fill** (Block List) The query used to fill the map. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill)) -- **size** (Block List) The query used to size the map. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the request block). (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size)) +- **facet** (String) The facet name. - -### Nested Schema for `widget.hostmap_definition.request.fill` + + + +### Nested Schema for `widget.hostmap_definition.request.size.rum_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. Optional: -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--process_query)) -- **q** (String) The metric query to use for this widget. -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query)) +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.request.fill.apm_query` + + + +### Nested Schema for `widget.hostmap_definition.request.size.security_query` Required: @@ -8193,13 +9338,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.compute_query` + +### Nested Schema for `widget.hostmap_definition.request.size.security_query.compute_query` Required: @@ -8211,17 +9356,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.group_by` + +### Nested Schema for `widget.hostmap_definition.request.size.security_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--group_by--sort_query)) - -### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.group_by.sort_query` + +### Nested Schema for `widget.hostmap_definition.request.size.security_query.group_by.sort_query` Required: @@ -8234,8 +9379,8 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.fill.apm_query.multi_compute` + +### Nested Schema for `widget.hostmap_definition.request.size.security_query.multi_compute` Required: @@ -8248,86 +9393,159 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.fill.log_query` + + + +### Nested Schema for `widget.hostmap_definition.style` + +Optional: + +- **fill_max** (String) The max value to use to color the map. +- **fill_min** (String) The min value to use to color the map. +- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. +- **palette_flip** (Boolean) A Boolean indicating whether to flip the palette tones. + + + + +### Nested Schema for `widget.iframe_definition` Required: -- **index** (String) The name of the index to query. +- **url** (String) The URL to use as a data source for the widget. + + + +### Nested Schema for `widget.image_definition` + +Required: + +- **url** (String) The URL to use as a data source for the widget. + +Optional: + +- **has_background** (Boolean) Whether to display a background or not. +- **has_border** (Boolean) Whether to display a border or not. +- **horizontal_align** (String) The horizontal alignment for the widget. Valid values are `center`, `left`, `right`. +- **margin** (String) The margins to use around the image. Note: `small` and `large` values are deprecated. Valid values are `sm`, `md`, `lg`, `small`, `large`. +- **sizing** (String) The preferred method to adapt the dimensions of the image. The values are based on the image `object-fit` CSS properties. Note: `zoom`, `fit` and `center` values are deprecated. Valid values are `fill`, `contain`, `cover`, `none`, `scale-down`, `zoom`, `fit`, `center`. +- **url_dark_theme** (String) The URL in dark mode to use as a data source for the widget. +- **vertical_align** (String) The vertical alignment for the widget. Valid values are `center`, `top`, `bottom`. + + + +### Nested Schema for `widget.log_stream_definition` Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--multi_compute)) -- **search_query** (String) The search query to use. +- **columns** (List of String) Stringified list of columns to use, for example: `["column1","column2","column3"]`. +- **indexes** (List of String) An array of index names to query in the stream. +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **message_display** (String) The number of log lines to display. Valid values are `inline`, `expanded-md`, `expanded-lg`. +- **query** (String) The query to use in the widget. +- **show_date_column** (Boolean) If the date column should be displayed. +- **show_message_column** (Boolean) If the message column should be displayed. +- **sort** (Block List, Max: 1) The facet and order to sort the data, for example: `{"column": "time", "order": "desc"}`. (see [below for nested schema](#nestedblock--widget--log_stream_definition--sort)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). - -### Nested Schema for `widget.hostmap_definition.request.fill.log_query.compute_query` + +### Nested Schema for `widget.log_stream_definition.sort` Required: -- **aggregation** (String) The aggregation method. +- **column** (String) The facet path for the column +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. -Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. + +### Nested Schema for `widget.manage_status_definition` - -### Nested Schema for `widget.hostmap_definition.request.fill.log_query.group_by` +Required: + +- **query** (String) The query to use in the widget. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--log_query--group_by--sort_query)) +- **color_preference** (String) Whether to colorize text or background. Valid values are `background`, `text`. +- **display_format** (String) The display setting to use. Valid values are `counts`, `countsAndList`, `list`. +- **hide_zero_counts** (Boolean) A Boolean indicating whether to hide empty categories. +- **show_last_triggered** (Boolean) A Boolean indicating whether to show when monitors/groups last triggered. +- **sort** (String) The method to sort the monitors. Valid values are `name`, `group`, `status`, `tags`, `triggered`, `group,asc`, `group,desc`, `name,asc`, `name,desc`, `status,asc`, `status,desc`, `tags,asc`, `tags,desc`, `triggered,asc`, `triggered,desc`. +- **summary_type** (String) The summary type to use. Valid values are `monitors`, `groups`, `combined`. +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). - -### Nested Schema for `widget.hostmap_definition.request.fill.log_query.group_by.sort_query` + + +### Nested Schema for `widget.note_definition` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **content** (String) The content of the note. Optional: -- **facet** (String) The facet name. - - - - -### Nested Schema for `widget.hostmap_definition.request.fill.log_query.multi_compute` +- **background_color** (String) The background color of the note. +- **font_size** (String) The size of the text. +- **has_padding** (Boolean) Whether to add padding or not. +- **show_tick** (Boolean) Whether to show a tick or not. +- **text_align** (String) The alignment of the widget's text. Valid values are `center`, `left`, `right`. +- **tick_edge** (String) When `tick = true`, a string indicating on which side of the widget the tick should be displayed. Valid values are `bottom`, `left`, `right`, `top`. +- **tick_pos** (String) When `tick = true`, a string with a percent sign indicating the position of the tick, for example: `tick_pos = "50%"` is centered alignment. +- **vertical_align** (String) The vertical alignment for the widget. Valid values are `center`, `top`, `bottom`. -Required: -- **aggregation** (String) The aggregation method. + +### Nested Schema for `widget.query_table_definition` Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--custom_link)) +- **has_search_bar** (String) Controls the display of the search bar. Valid values are `always`, `never`, `auto`. +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--query_table_definition--request)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). + +### Nested Schema for `widget.query_table_definition.custom_link` +Optional: - -### Nested Schema for `widget.hostmap_definition.request.fill.process_query` +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. -Required: -- **metric** (String) Your chosen metric. + +### Nested Schema for `widget.query_table_definition.request` Optional: -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. - +- **aggregator** (String) The aggregator to use for time aggregation. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. +- **alias** (String) The alias for the column name (defaults to metric name). +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query)) +- **apm_stats_query** (Block List, Max: 1) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_stats_query)) +- **cell_display_mode** (List of String) A list of display modes for each table cell. List items one of `number`, `bar`. Valid values are `number`, `bar`. +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background, depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--conditional_formats)) +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula)) +- **limit** (Number) The number of lines to show in the table. +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query)) +- **order** (String) The sort order for the rows. Valid values are `asc`, `desc`. +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--process_query)) +- **q** (String) The metric query to use for this widget. +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query)) - -### Nested Schema for `widget.hostmap_definition.request.fill.rum_query` + +### Nested Schema for `widget.query_table_definition.request.apm_query` Required: @@ -8335,13 +9553,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.compute_query` + +### Nested Schema for `widget.query_table_definition.request.apm_query.compute_query` Required: @@ -8353,17 +9571,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.group_by` + +### Nested Schema for `widget.query_table_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.group_by.sort_query` + +### Nested Schema for `widget.query_table_definition.request.apm_query.group_by.sort_query` Required: @@ -8376,8 +9594,8 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.fill.rum_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.apm_query.multi_compute` Required: @@ -8390,85 +9608,101 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.fill.security_query` + +### Nested Schema for `widget.query_table_definition.request.apm_stats_query` Required: -- **index** (String) The name of the index to query. +- **env** (String) The environment name. +- **name** (String) The operation name associated with the service. +- **primary_tag** (String) The organization's host group name and value. +- **row_type** (String) The level of detail for the request. Valid values are `service`, `resource`, `span`. +- **service** (String) The service name. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--multi_compute)) -- **search_query** (String) The search query to use. +- **columns** (Block List) Column properties used by the front end for display. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_stats_query--columns)) +- **resource** (String) The resource name. - -### Nested Schema for `widget.hostmap_definition.request.fill.security_query.compute_query` + +### Nested Schema for `widget.query_table_definition.request.apm_stats_query.columns` Required: -- **aggregation** (String) The aggregation method. +- **name** (String) The column name. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **alias** (String) A user-assigned alias for the column. +- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.hostmap_definition.request.fill.security_query.group_by` + + +### Nested Schema for `widget.query_table_definition.request.conditional_formats` + +Required: + +- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. +- **palette** (String) The color palette to apply. Valid values are `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`. +- **value** (Number) A value for the comparator. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--fill--security_query--group_by--sort_query)) +- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. +- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. +- **hide_value** (Boolean) Setting this to True hides values. +- **image_url** (String) Displays an image as the background. +- **metric** (String) The metric from the request to correlate with this conditional format. +- **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.hostmap_definition.request.fill.security_query.group_by.sort_query` + + +### Nested Schema for `widget.query_table_definition.request.formula` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **formula_expression** (String) A string expression built from queries, formulas, and functions. Optional: -- **facet** (String) The facet name. - - +- **alias** (String) An expression alias. +- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula--limit)) - -### Nested Schema for `widget.hostmap_definition.request.fill.security_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.formula.conditional_formats` Required: -- **aggregation** (String) The aggregation method. +- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. +- **palette** (String) The color palette to apply. Valid values are `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`. +- **value** (Number) A value for the comparator. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. +- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. +- **hide_value** (Boolean) Setting this to True hides values. +- **image_url** (String) Displays an image as the background. +- **metric** (String) The metric from the request to correlate with this conditional format. +- **timeframe** (String) Defines the displayed timeframe. + +### Nested Schema for `widget.query_table_definition.request.formula.limit` +Optional: - -### Nested Schema for `widget.hostmap_definition.request.size` +- **count** (Number) The number of results to return +- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. -Optional: -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--process_query)) -- **q** (String) The metric query to use for this widget. -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query)) - -### Nested Schema for `widget.hostmap_definition.request.size.apm_query` + +### Nested Schema for `widget.query_table_definition.request.log_query` Required: @@ -8476,13 +9710,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.hostmap_definition.request.size.apm_query.compute_query` + +### Nested Schema for `widget.query_table_definition.request.log_query.compute_query` Required: @@ -8494,17 +9728,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.request.size.apm_query.group_by` + +### Nested Schema for `widget.query_table_definition.request.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--apm_query--group_by--sort_query)) - - -### Nested Schema for `widget.hostmap_definition.request.size.apm_query.group_by.sort_query` +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--group_by--sort_query)) + + +### Nested Schema for `widget.query_table_definition.request.log_query.group_by.sort_query` Required: @@ -8517,8 +9751,8 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.size.apm_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.log_query.multi_compute` Required: @@ -8531,150 +9765,170 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.size.log_query` + +### Nested Schema for `widget.query_table_definition.request.process_query` Required: -- **index** (String) The name of the index to query. +- **metric** (String) Your chosen metric. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--multi_compute)) -- **search_query** (String) The search query to use. - - -### Nested Schema for `widget.hostmap_definition.request.size.log_query.compute_query` +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. -Required: -- **aggregation** (String) The aggregation method. + +### Nested Schema for `widget.query_table_definition.request.query` Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--process_query)) + + +### Nested Schema for `widget.query_table_definition.request.query.apm_dependency_stats_query` +Required: - -### Nested Schema for `widget.hostmap_definition.request.size.log_query.group_by` +- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **operation_name** (String) Name of operation on service. +- **resource_name** (String) APM resource. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--log_query--group_by--sort_query)) +- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. +- **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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - -### Nested Schema for `widget.hostmap_definition.request.size.log_query.group_by.sort_query` + + +### Nested Schema for `widget.query_table_definition.request.query.apm_resource_stats_query` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. Optional: -- **facet** (String) The facet name. - +- **group_by** (List of String) Array of fields to group results by. +- **operation_name** (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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. +- **resource_name** (String) APM resource. - -### Nested Schema for `widget.hostmap_definition.request.size.log_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.query.event_query` Required: -- **aggregation** (String) The aggregation method. +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--compute)) +- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. +- **name** (String) The name of query for use in formulas. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. - - +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--group_by)) +- **indexes** (List of String) An array of index names to query in the stream. +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--search)) - -### Nested Schema for `widget.hostmap_definition.request.size.process_query` + +### Nested Schema for `widget.query_table_definition.request.query.event_query.compute` Required: -- **metric** (String) Your chosen metric. +- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. Optional: -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. +- **interval** (Number) A time interval in milliseconds. +- **metric** (String) The measurable attribute to compute. - -### Nested Schema for `widget.hostmap_definition.request.size.rum_query` + +### Nested Schema for `widget.query_table_definition.request.query.event_query.group_by` Required: -- **index** (String) The name of the index to query. +- **facet** (String) The event facet. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--multi_compute)) -- **search_query** (String) The search query to use. +- **limit** (Number) The number of groups to return. +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--group_by--sort)) - -### Nested Schema for `widget.hostmap_definition.request.size.rum_query.compute_query` + +### Nested Schema for `widget.query_table_definition.request.query.event_query.group_by.sort` Required: -- **aggregation** (String) The aggregation method. +- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **metric** (String) The metric used for sorting group by results. +- **order** (String) Direction of sort. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.hostmap_definition.request.size.rum_query.group_by` -Optional: + +### Nested Schema for `widget.query_table_definition.request.query.event_query.search` -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--rum_query--group_by--sort_query)) +Required: - -### Nested Schema for `widget.hostmap_definition.request.size.rum_query.group_by.sort_query` +- **query** (String) The events search string. + + + + +### Nested Schema for `widget.query_table_definition.request.query.metric_query` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **name** (String) The name of the query for use in formulas. +- **query** (String) The metrics query definition. Optional: -- **facet** (String) The facet name. - +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **data_source** (String) The data source for metrics queries. - -### Nested Schema for `widget.hostmap_definition.request.size.rum_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.query.process_query` Required: -- **aggregation** (String) The aggregation method. +- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. +- **metric** (String) The process metric name. +- **name** (String) The name of query for use in formulas. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. +- **limit** (Number) The number of hits to return. +- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. +- **tag_filters** (List of String) An array of tags to filter by. +- **text_filter** (String) The text to use as a filter. - -### Nested Schema for `widget.hostmap_definition.request.size.security_query` + +### Nested Schema for `widget.query_table_definition.request.rum_query` Required: @@ -8682,13 +9936,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.hostmap_definition.request.size.security_query.compute_query` + +### Nested Schema for `widget.query_table_definition.request.rum_query.compute_query` Required: @@ -8700,17 +9954,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.hostmap_definition.request.size.security_query.group_by` + +### Nested Schema for `widget.query_table_definition.request.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--hostmap_definition--request--size--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.hostmap_definition.request.size.security_query.group_by.sort_query` + +### Nested Schema for `widget.query_table_definition.request.rum_query.group_by.sort_query` Required: @@ -8723,8 +9977,8 @@ Optional: - -### Nested Schema for `widget.hostmap_definition.request.size.security_query.multi_compute` + +### Nested Schema for `widget.query_table_definition.request.rum_query.multi_compute` Required: @@ -8737,127 +9991,90 @@ Optional: + +### Nested Schema for `widget.query_table_definition.request.security_query` +Required: - -### Nested Schema for `widget.hostmap_definition.style` +- **index** (String) The name of the index to query. Optional: -- **fill_max** (String) The max value to use to color the map. -- **fill_min** (String) The min value to use to color the map. -- **palette** (String) A color palette to apply to the widget. The available options are available at: https://docs.datadoghq.com/dashboards/widgets/timeseries/#appearance. -- **palette_flip** (Boolean) A Boolean indicating whether to flip the palette tones. - - - - -### Nested Schema for `widget.iframe_definition` - -Required: - -- **url** (String) The URL to use as a data source for the widget. - +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--multi_compute)) +- **search_query** (String) The search query to use. - -### Nested Schema for `widget.image_definition` + +### Nested Schema for `widget.query_table_definition.request.security_query.compute_query` Required: -- **url** (String) The URL to use as a data source for the widget. +- **aggregation** (String) The aggregation method. Optional: -- **has_background** (Boolean) Whether to display a background or not. -- **has_border** (Boolean) Whether to display a border or not. -- **horizontal_align** (String) The horizontal alignment for the widget. Valid values are `center`, `left`, `right`. -- **margin** (String) The margins to use around the image. Note: `small` and `large` values are deprecated. Valid values are `sm`, `md`, `lg`, `small`, `large`. -- **sizing** (String) The preferred method to adapt the dimensions of the image. The values are based on the image `object-fit` CSS properties. Note: `zoom`, `fit` and `center` values are deprecated. Valid values are `fill`, `contain`, `cover`, `none`, `scale-down`, `zoom`, `fit`, `center`. -- **url_dark_theme** (String) The URL in dark mode to use as a data source for the widget. -- **vertical_align** (String) The vertical alignment for the widget. Valid values are `center`, `top`, `bottom`. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.log_stream_definition` + +### Nested Schema for `widget.query_table_definition.request.security_query.group_by` Optional: -- **columns** (List of String) Stringified list of columns to use, for example: `["column1","column2","column3"]`. -- **indexes** (List of String) An array of index names to query in the stream. -- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **message_display** (String) The number of log lines to display. Valid values are `inline`, `expanded-md`, `expanded-lg`. -- **query** (String) The query to use in the widget. -- **show_date_column** (Boolean) If the date column should be displayed. -- **show_message_column** (Boolean) If the message column should be displayed. -- **sort** (Block List, Max: 1) The facet and order to sort the data, for example: `{"column": "time", "order": "desc"}`. (see [below for nested schema](#nestedblock--widget--log_stream_definition--sort)) -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). - - -### Nested Schema for `widget.log_stream_definition.sort` - -Required: - -- **column** (String) The facet path for the column -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. - - +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--group_by--sort_query)) - -### Nested Schema for `widget.manage_status_definition` + +### Nested Schema for `widget.query_table_definition.request.security_query.group_by.sort_query` Required: -- **query** (String) The query to use in the widget. +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **color_preference** (String) Whether to colorize text or background. Valid values are `background`, `text`. -- **display_format** (String) The display setting to use. Valid values are `counts`, `countsAndList`, `list`. -- **hide_zero_counts** (Boolean) A Boolean indicating whether to hide empty categories. -- **show_last_triggered** (Boolean) A Boolean indicating whether to show when monitors/groups last triggered. -- **sort** (String) The method to sort the monitors. Valid values are `name`, `group`, `status`, `tags`, `triggered`, `group,asc`, `group,desc`, `name,asc`, `name,desc`, `status,asc`, `status,desc`, `tags,asc`, `tags,desc`, `triggered,asc`, `triggered,desc`. -- **summary_type** (String) The summary type to use. Valid values are `monitors`, `groups`, `combined`. -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). +- **facet** (String) The facet name. - -### Nested Schema for `widget.note_definition` + + +### Nested Schema for `widget.query_table_definition.request.security_query.multi_compute` Required: -- **content** (String) The content of the note. +- **aggregation** (String) The aggregation method. Optional: -- **background_color** (String) The background color of the note. -- **font_size** (String) The size of the text. -- **has_padding** (Boolean) Whether to add padding or not. -- **show_tick** (Boolean) Whether to show a tick or not. -- **text_align** (String) The alignment of the widget's text. Valid values are `center`, `left`, `right`. -- **tick_edge** (String) When `tick = true`, a string indicating on which side of the widget the tick should be displayed. Valid values are `bottom`, `left`, `right`, `top`. -- **tick_pos** (String) When `tick = true`, a string with a percent sign indicating the position of the tick, for example: `tick_pos = "50%"` is centered alignment. -- **vertical_align** (String) The vertical alignment for the widget. Valid values are `center`, `top`, `bottom`. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_table_definition` + + + + +### Nested Schema for `widget.query_value_definition` Optional: -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--custom_link)) -- **has_search_bar** (String) Controls the display of the search bar. Valid values are `always`, `never`, `auto`. +- **autoscale** (Boolean) A Boolean indicating whether to automatically scale the tile. +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--custom_link)) +- **custom_unit** (String) The unit for the value displayed in the widget. - **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--query_table_definition--request)) +- **precision** (Number) The precision to use when displaying the tile. +- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--query_value_definition--request)) +- **text_align** (String) The alignment of the widget's text. Valid values are `center`, `left`, `right`. - **title** (String) The title of the widget. - **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. - **title_size** (String) The size of the widget's title (defaults to 16). - -### Nested Schema for `widget.query_table_definition.custom_link` + +### Nested Schema for `widget.query_value_definition.custom_link` Optional: @@ -8867,29 +10084,25 @@ Optional: - **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.query_table_definition.request` + +### Nested Schema for `widget.query_value_definition.request` Optional: - **aggregator** (String) The aggregator to use for time aggregation. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. -- **alias** (String) The alias for the column name (defaults to metric name). -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query)) -- **apm_stats_query** (Block List, Max: 1) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_stats_query)) -- **cell_display_mode** (List of String) A list of display modes for each table cell. List items one of `number`, `bar`. Valid values are `number`, `bar`. -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background, depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--conditional_formats)) -- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula)) -- **limit** (Number) The number of lines to show in the table. -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query)) -- **order** (String) The sort order for the rows. Valid values are `asc`, `desc`. -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--process_query)) +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query)) +- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query)) +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--conditional_formats)) +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--process_query)) - **q** (String) The metric query to use for this widget. -- **query** (Block List) (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query)) -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query)) - -### Nested Schema for `widget.query_table_definition.request.apm_query` + +### Nested Schema for `widget.query_value_definition.request.apm_query` Required: @@ -8897,13 +10110,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_table_definition.request.apm_query.compute_query` + +### Nested Schema for `widget.query_value_definition.request.apm_query.compute_query` Required: @@ -8915,17 +10128,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_table_definition.request.apm_query.group_by` + +### Nested Schema for `widget.query_value_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.query_table_definition.request.apm_query.group_by.sort_query` + +### Nested Schema for `widget.query_value_definition.request.apm_query.group_by.sort_query` Required: @@ -8938,8 +10151,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.apm_query.multi_compute` + +### Nested Schema for `widget.query_value_definition.request.apm_query.multi_compute` Required: @@ -8952,39 +10165,72 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.apm_stats_query` + +### Nested Schema for `widget.query_value_definition.request.audit_query` Required: -- **env** (String) The environment name. -- **name** (String) The operation name associated with the service. -- **primary_tag** (String) The organization's host group name and value. -- **row_type** (String) The level of detail for the request. Valid values are `service`, `resource`, `span`. -- **service** (String) The service name. +- **index** (String) The name of the index to query. Optional: -- **columns** (Block List) Column properties used by the front end for display. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--apm_stats_query--columns)) -- **resource** (String) The resource name. +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--multi_compute)) +- **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_table_definition.request.apm_stats_query.columns` + +### Nested Schema for `widget.query_value_definition.request.audit_query.compute_query` Required: -- **name** (String) The column name. +- **aggregation** (String) The aggregation method. Optional: -- **alias** (String) A user-assigned alias for the column. -- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.query_value_definition.request.audit_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--group_by--sort_query)) + + +### Nested Schema for `widget.query_value_definition.request.audit_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. - **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +Optional: + +- **facet** (String) The facet name. - -### Nested Schema for `widget.query_table_definition.request.conditional_formats` + + +### Nested Schema for `widget.query_value_definition.request.audit_query.multi_compute` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + + +### Nested Schema for `widget.query_value_definition.request.conditional_formats` Required: @@ -9002,8 +10248,8 @@ Optional: - **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.query_table_definition.request.formula` + +### Nested Schema for `widget.query_value_definition.request.formula` Required: @@ -9013,11 +10259,11 @@ Optional: - **alias** (String) An expression alias. - **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula--conditional_formats)) -- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--formula--limit)) +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula--limit)) - -### Nested Schema for `widget.query_table_definition.request.formula.conditional_formats` + +### Nested Schema for `widget.query_value_definition.request.formula.conditional_formats` Required: @@ -9035,8 +10281,8 @@ Optional: - **timeframe** (String) Defines the displayed timeframe. - -### Nested Schema for `widget.query_table_definition.request.formula.limit` + +### Nested Schema for `widget.query_value_definition.request.formula.limit` Optional: @@ -9045,8 +10291,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.log_query` + +### Nested Schema for `widget.query_value_definition.request.log_query` Required: @@ -9054,13 +10300,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_table_definition.request.log_query.compute_query` + +### Nested Schema for `widget.query_value_definition.request.log_query.compute_query` Required: @@ -9072,17 +10318,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_table_definition.request.log_query.group_by` + +### Nested Schema for `widget.query_value_definition.request.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--group_by--sort_query)) - -### Nested Schema for `widget.query_table_definition.request.log_query.group_by.sort_query` + +### Nested Schema for `widget.query_value_definition.request.log_query.group_by.sort_query` Required: @@ -9095,8 +10341,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.log_query.multi_compute` + +### Nested Schema for `widget.query_value_definition.request.log_query.multi_compute` Required: @@ -9109,8 +10355,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.process_query` + +### Nested Schema for `widget.query_value_definition.request.process_query` Required: @@ -9123,19 +10369,19 @@ Optional: - **search_by** (String) Your chosen search term. - -### Nested Schema for `widget.query_table_definition.request.query` + +### Nested Schema for `widget.query_value_definition.request.query` Optional: -- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--apm_dependency_stats_query)) -- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--apm_resource_stats_query)) -- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query)) -- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--metric_query)) -- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--process_query)) +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--process_query)) - -### Nested Schema for `widget.query_table_definition.request.query.apm_dependency_stats_query` + +### Nested Schema for `widget.query_value_definition.request.query.apm_dependency_stats_query` Required: @@ -9154,8 +10400,8 @@ Optional: - **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - -### Nested Schema for `widget.query_table_definition.request.query.apm_resource_stats_query` + +### Nested Schema for `widget.query_value_definition.request.query.apm_resource_stats_query` Required: @@ -9174,23 +10420,23 @@ Optional: - **resource_name** (String) APM resource. - -### Nested Schema for `widget.query_table_definition.request.query.event_query` + +### Nested Schema for `widget.query_value_definition.request.query.event_query` Required: -- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--compute)) +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--compute)) - **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. - **name** (String) The name of query for use in formulas. Optional: -- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--group_by)) +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--group_by)) - **indexes** (List of String) An array of index names to query in the stream. -- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--search)) - - -### Nested Schema for `widget.query_table_definition.request.query.event_query.compute` +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--search)) + + +### Nested Schema for `widget.query_value_definition.request.query.event_query.compute` Required: @@ -9202,8 +10448,8 @@ Optional: - **metric** (String) The measurable attribute to compute. - -### Nested Schema for `widget.query_table_definition.request.query.event_query.group_by` + +### Nested Schema for `widget.query_value_definition.request.query.event_query.group_by` Required: @@ -9212,10 +10458,10 @@ Required: Optional: - **limit** (Number) The number of groups to return. -- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--query--event_query--group_by--sort)) +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--group_by--sort)) - -### Nested Schema for `widget.query_table_definition.request.query.event_query.group_by.sort` + +### Nested Schema for `widget.query_value_definition.request.query.event_query.group_by.sort` Required: @@ -9228,8 +10474,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.query.event_query.search` + +### Nested Schema for `widget.query_value_definition.request.query.event_query.search` Required: @@ -9237,8 +10483,8 @@ Required: - -### Nested Schema for `widget.query_table_definition.request.query.metric_query` + +### Nested Schema for `widget.query_value_definition.request.query.metric_query` Required: @@ -9251,8 +10497,8 @@ Optional: - **data_source** (String) The data source for metrics queries. - -### Nested Schema for `widget.query_table_definition.request.query.process_query` + +### Nested Schema for `widget.query_value_definition.request.query.process_query` Required: @@ -9271,8 +10517,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.rum_query` + +### Nested Schema for `widget.query_value_definition.request.rum_query` Required: @@ -9280,13 +10526,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_table_definition.request.rum_query.compute_query` + +### Nested Schema for `widget.query_value_definition.request.rum_query.compute_query` Required: @@ -9298,17 +10544,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_table_definition.request.rum_query.group_by` + +### Nested Schema for `widget.query_value_definition.request.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.query_table_definition.request.rum_query.group_by.sort_query` + +### Nested Schema for `widget.query_value_definition.request.rum_query.group_by.sort_query` Required: @@ -9321,8 +10567,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.rum_query.multi_compute` + +### Nested Schema for `widget.query_value_definition.request.rum_query.multi_compute` Required: @@ -9335,8 +10581,8 @@ Optional: - -### Nested Schema for `widget.query_table_definition.request.security_query` + +### Nested Schema for `widget.query_value_definition.request.security_query` Required: @@ -9344,13 +10590,49 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_table_definition.request.security_query.compute_query` + +### Nested Schema for `widget.query_value_definition.request.security_query.compute_query` + +Required: + +- **aggregation** (String) The aggregation method. + +Optional: + +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + + + +### Nested Schema for `widget.query_value_definition.request.security_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.query_value_definition.request.security_query.group_by.sort_query` + +Required: + +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +Optional: + +- **facet** (String) The facet name. + + + + +### Nested Schema for `widget.query_value_definition.request.security_query.multi_compute` Required: @@ -9362,91 +10644,229 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_table_definition.request.security_query.group_by` + + + + +### Nested Schema for `widget.scatterplot_definition` + +Optional: + +- **color_by_groups** (List of String) List of groups used for colors. +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--custom_link)) +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **request** (Block List, Max: 1) A nested block describing the request to use when displaying the widget. Exactly one `request` block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). +- **xaxis** (Block List, Max: 1) A nested block describing the X-Axis Controls. Exactly one nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--xaxis)) +- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. Exactly one nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--yaxis)) + + +### Nested Schema for `widget.scatterplot_definition.custom_link` + +Optional: + +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. + + + +### Nested Schema for `widget.scatterplot_definition.request` + +Optional: + +- **scatterplot_table** (Block List) Scatterplot request containing formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table)) +- **x** (Block List) The query used for the X-Axis. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the block). (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x)) +- **y** (Block List) The query used for the Y-Axis. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the block). (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y)) + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table` + +Optional: + +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--formula)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query)) + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.formula` + +Required: + +- **dimension** (String) Dimension of the Scatterplot. Valid values are `x`, `y`, `radius`, `color`. +- **formula_expression** (String) A string expression built from queries, formulas, and functions. + +Optional: + +- **alias** (String) An expression alias. + + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query` + +Optional: + +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--process_query)) + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.apm_dependency_stats_query` + +Required: + +- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **operation_name** (String) Name of operation on service. +- **resource_name** (String) APM resource. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. + +Optional: + +- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. +- **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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. + + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.apm_resource_stats_query` + +Required: + +- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. + +Optional: + +- **group_by** (List of String) Array of fields to group results by. +- **operation_name** (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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. +- **resource_name** (String) APM resource. + + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query` + +Required: + +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--compute)) +- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. +- **name** (String) The name of query for use in formulas. + +Optional: + +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--group_by)) +- **indexes** (List of String) An array of index names to query in the stream. +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--search)) + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.compute` + +Required: + +- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. + +Optional: + +- **interval** (Number) A time interval in milliseconds. +- **metric** (String) The measurable attribute to compute. + + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by` + +Required: + +- **facet** (String) The event facet. + +Optional: + +- **limit** (Number) The number of groups to return. +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--group_by--sort)) + + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by.sort` + +Required: + +- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_table_definition--request--security_query--group_by--sort_query)) +- **metric** (String) The metric used for sorting group by results. +- **order** (String) Direction of sort. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.query_table_definition.request.security_query.group_by.sort_query` -Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.search` -Optional: +Required: -- **facet** (String) The facet name. +- **query** (String) The events search string. - -### Nested Schema for `widget.query_table_definition.request.security_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.metric_query` Required: -- **aggregation** (String) The aggregation method. +- **name** (String) The name of the query for use in formulas. +- **query** (String) The metrics query definition. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. - +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **data_source** (String) The data source for metrics queries. + +### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.process_query` +Required: - -### Nested Schema for `widget.query_value_definition` +- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. +- **metric** (String) The process metric name. +- **name** (String) The name of query for use in formulas. Optional: -- **autoscale** (Boolean) A Boolean indicating whether to automatically scale the tile. -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--custom_link)) -- **custom_unit** (String) The unit for the value displayed in the widget. -- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **precision** (Number) The precision to use when displaying the tile. -- **request** (Block List) A nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query` or `process_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--query_value_definition--request)) -- **text_align** (String) The alignment of the widget's text. Valid values are `center`, `left`, `right`. -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). - - -### Nested Schema for `widget.query_value_definition.custom_link` +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. +- **limit** (Number) The number of hits to return. +- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. +- **tag_filters** (List of String) An array of tags to filter by. +- **text_filter** (String) The text to use as a filter. -Optional: -- **is_hidden** (Boolean) The flag for toggling context menu link visibility. -- **label** (String) The label for the custom link URL. -- **link** (String) The URL of the custom link. -- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.query_value_definition.request` + +### Nested Schema for `widget.scatterplot_definition.request.x` Optional: -- **aggregator** (String) The aggregator to use for time aggregation. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query)) -- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query)) -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--conditional_formats)) -- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--process_query)) +- **aggregator** (String) Aggregator used for the request. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--process_query)) - **q** (String) The metric query to use for this widget. -- **query** (Block List) (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query)) -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query)) - -### Nested Schema for `widget.query_value_definition.request.apm_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.apm_query` Required: @@ -9454,13 +10874,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.apm_query.compute_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.compute_query` Required: @@ -9472,17 +10892,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.apm_query.group_by` + +### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.query_value_definition.request.apm_query.group_by.sort_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.group_by.sort_query` Required: @@ -9495,8 +10915,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.apm_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.multi_compute` Required: @@ -9509,8 +10929,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.audit_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.log_query` Required: @@ -9518,13 +10938,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.audit_query.compute_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.log_query.compute_query` Required: @@ -9536,17 +10956,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.audit_query.group_by` + +### Nested Schema for `widget.scatterplot_definition.request.x.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--audit_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--group_by--sort_query)) - -### Nested Schema for `widget.query_value_definition.request.audit_query.group_by.sort_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.log_query.group_by.sort_query` Required: @@ -9559,8 +10979,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.audit_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.x.log_query.multi_compute` Required: @@ -9573,70 +10993,22 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.conditional_formats` - -Required: - -- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. -- **palette** (String) The color palette to apply. Valid values are `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`. -- **value** (Number) A value for the comparator. - -Optional: - -- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. -- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. -- **hide_value** (Boolean) Setting this to True hides values. -- **image_url** (String) Displays an image as the background. -- **metric** (String) The metric from the request to correlate with this conditional format. -- **timeframe** (String) Defines the displayed timeframe. - - - -### Nested Schema for `widget.query_value_definition.request.formula` - -Required: - -- **formula_expression** (String) A string expression built from queries, formulas, and functions. - -Optional: - -- **alias** (String) An expression alias. -- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. -- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula--conditional_formats)) -- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--formula--limit)) - - -### Nested Schema for `widget.query_value_definition.request.formula.conditional_formats` + +### Nested Schema for `widget.scatterplot_definition.request.x.process_query` Required: -- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. -- **palette** (String) The color palette to apply. Valid values are `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`. -- **value** (Number) A value for the comparator. - -Optional: - -- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. -- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. -- **hide_value** (Boolean) Setting this to True hides values. -- **image_url** (String) Displays an image as the background. -- **metric** (String) The metric from the request to correlate with this conditional format. -- **timeframe** (String) Defines the displayed timeframe. - - - -### Nested Schema for `widget.query_value_definition.request.formula.limit` +- **metric** (String) Your chosen metric. Optional: -- **count** (Number) The number of results to return -- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. - +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. - -### Nested Schema for `widget.query_value_definition.request.log_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.rum_query` Required: @@ -9644,13 +11016,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.log_query.compute_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.compute_query` Required: @@ -9662,17 +11034,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.log_query.group_by` + +### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.query_value_definition.request.log_query.group_by.sort_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.group_by.sort_query` Required: @@ -9685,8 +11057,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.log_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.multi_compute` Required: @@ -9699,170 +11071,150 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.process_query` - -Required: - -- **metric** (String) Your chosen metric. - -Optional: - -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. - - - -### Nested Schema for `widget.query_value_definition.request.query` - -Optional: - -- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--apm_dependency_stats_query)) -- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--apm_resource_stats_query)) -- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query)) -- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--metric_query)) -- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--process_query)) - - -### Nested Schema for `widget.query_value_definition.request.query.apm_dependency_stats_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.security_query` Required: -- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. -- **env** (String) APM Environment. -- **name** (String) The name of query for use in formulas. -- **operation_name** (String) Name of operation on service. -- **resource_name** (String) APM resource. -- **service** (String) APM service. -- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. +- **index** (String) The name of the index to query. Optional: -- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. -- **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. -- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--multi_compute)) +- **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.query.apm_resource_stats_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.security_query.compute_query` Required: -- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. -- **env** (String) APM Environment. -- **name** (String) The name of query for use in formulas. -- **service** (String) APM service. -- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. +- **aggregation** (String) The aggregation method. Optional: -- **group_by** (List of String) Array of fields to group results by. -- **operation_name** (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. -- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. -- **resource_name** (String) APM resource. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.query.event_query` + +### Nested Schema for `widget.scatterplot_definition.request.x.security_query.group_by` + +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.scatterplot_definition.request.x.security_query.group_by.sort_query` Required: -- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--compute)) -- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. -- **name** (String) The name of query for use in formulas. +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--group_by)) -- **indexes** (List of String) An array of index names to query in the stream. -- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--search)) +- **facet** (String) The facet name. + - -### Nested Schema for `widget.query_value_definition.request.query.event_query.compute` + + +### Nested Schema for `widget.scatterplot_definition.request.x.security_query.multi_compute` Required: -- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. +- **aggregation** (String) The aggregation method. Optional: -- **interval** (Number) A time interval in milliseconds. -- **metric** (String) The measurable attribute to compute. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.query.event_query.group_by` -Required: -- **facet** (String) The event facet. + +### Nested Schema for `widget.scatterplot_definition.request.y` Optional: -- **limit** (Number) The number of groups to return. -- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--query--event_query--group_by--sort)) +- **aggregator** (String) Aggregator used for the request. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--process_query)) +- **q** (String) The metric query to use for this widget. +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query)) - -### Nested Schema for `widget.query_value_definition.request.query.event_query.group_by.sort` + +### Nested Schema for `widget.scatterplot_definition.request.y.apm_query` Required: -- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. +- **index** (String) The name of the index to query. Optional: -- **metric** (String) The metric used for sorting group by results. -- **order** (String) Direction of sort. Valid values are `asc`, `desc`. +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--multi_compute)) +- **search_query** (String) The search query to use. + +### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.compute_query` +Required: - -### Nested Schema for `widget.query_value_definition.request.query.event_query.search` +- **aggregation** (String) The aggregation method. -Required: +Optional: -- **query** (String) The events search string. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + +### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.group_by` - -### Nested Schema for `widget.query_value_definition.request.query.metric_query` +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--group_by--sort_query)) + + +### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.group_by.sort_query` Required: -- **name** (String) The name of the query for use in formulas. -- **query** (String) The metrics query definition. +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. -- **data_source** (String) The data source for metrics queries. +- **facet** (String) The facet name. - -### Nested Schema for `widget.query_value_definition.request.query.process_query` + + +### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.multi_compute` Required: -- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. -- **metric** (String) The process metric name. -- **name** (String) The name of query for use in formulas. +- **aggregation** (String) The aggregation method. Optional: -- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. -- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. -- **limit** (Number) The number of hits to return. -- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. -- **tag_filters** (List of String) An array of tags to filter by. -- **text_filter** (String) The text to use as a filter. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.rum_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.log_query` Required: @@ -9870,13 +11222,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.rum_query.compute_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.log_query.compute_query` Required: @@ -9888,17 +11240,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.rum_query.group_by` + +### Nested Schema for `widget.scatterplot_definition.request.y.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--rum_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--group_by--sort_query)) - -### Nested Schema for `widget.query_value_definition.request.rum_query.group_by.sort_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.log_query.group_by.sort_query` Required: @@ -9911,8 +11263,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.rum_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.y.log_query.multi_compute` Required: @@ -9925,8 +11277,22 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.security_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.process_query` + +Required: + +- **metric** (String) Your chosen metric. + +Optional: + +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. + + + +### Nested Schema for `widget.scatterplot_definition.request.y.rum_query` Required: @@ -9934,13 +11300,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.query_value_definition.request.security_query.compute_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.compute_query` Required: @@ -9952,17 +11318,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.query_value_definition.request.security_query.group_by` + +### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--query_value_definition--request--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.query_value_definition.request.security_query.group_by.sort_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.group_by.sort_query` Required: @@ -9975,8 +11341,8 @@ Optional: - -### Nested Schema for `widget.query_value_definition.request.security_query.multi_compute` + +### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.multi_compute` Required: @@ -9989,228 +11355,208 @@ Optional: + +### Nested Schema for `widget.scatterplot_definition.request.y.security_query` +Required: - -### Nested Schema for `widget.scatterplot_definition` - -Optional: - -- **color_by_groups** (List of String) List of groups used for colors. -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--custom_link)) -- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. -- **request** (Block List, Max: 1) A nested block describing the request to use when displaying the widget. Exactly one `request` block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request)) -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). -- **xaxis** (Block List, Max: 1) A nested block describing the X-Axis Controls. Exactly one nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--xaxis)) -- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. Exactly one nested block is allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--yaxis)) - - -### Nested Schema for `widget.scatterplot_definition.custom_link` - -Optional: - -- **is_hidden** (Boolean) The flag for toggling context menu link visibility. -- **label** (String) The label for the custom link URL. -- **link** (String) The URL of the custom link. -- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - - - -### Nested Schema for `widget.scatterplot_definition.request` - -Optional: - -- **scatterplot_table** (Block List) Scatterplot request containing formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table)) -- **x** (Block List) The query used for the X-Axis. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the block). (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x)) -- **y** (Block List) The query used for the Y-Axis. Exactly one nested block is allowed using the structure below (exactly one of `q`, `apm_query`, `log_query`, `rum_query`, `security_query`, `apm_stats_query` or `process_query` is required within the block). (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y)) - - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table` +- **index** (String) The name of the index to query. Optional: -- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--formula)) -- **query** (Block List) (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--multi_compute)) +- **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.formula` + +### Nested Schema for `widget.scatterplot_definition.request.y.security_query.compute_query` Required: -- **dimension** (String) Dimension of the Scatterplot. Valid values are `x`, `y`, `radius`, `color`. -- **formula_expression** (String) A string expression built from queries, formulas, and functions. +- **aggregation** (String) The aggregation method. Optional: -- **alias** (String) An expression alias. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query` + +### Nested Schema for `widget.scatterplot_definition.request.y.security_query.group_by` Optional: -- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--apm_dependency_stats_query)) -- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--apm_resource_stats_query)) -- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query)) -- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--metric_query)) -- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--process_query)) +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.apm_dependency_stats_query` + +### Nested Schema for `widget.scatterplot_definition.request.y.security_query.group_by.sort_query` Required: -- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. -- **env** (String) APM Environment. -- **name** (String) The name of query for use in formulas. -- **operation_name** (String) Name of operation on service. -- **resource_name** (String) APM resource. -- **service** (String) APM service. -- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. -- **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. -- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. +- **facet** (String) The facet name. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.apm_resource_stats_query` + + +### Nested Schema for `widget.scatterplot_definition.request.y.security_query.multi_compute` Required: -- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. -- **env** (String) APM Environment. -- **name** (String) The name of query for use in formulas. -- **service** (String) APM service. -- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. +- **aggregation** (String) The aggregation method. Optional: -- **group_by** (List of String) Array of fields to group results by. -- **operation_name** (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. -- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. -- **resource_name** (String) APM resource. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query` -Required: -- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--compute)) -- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. -- **name** (String) The name of query for use in formulas. -Optional: + +### Nested Schema for `widget.scatterplot_definition.xaxis` -- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--group_by)) -- **indexes** (List of String) An array of index names to query in the stream. -- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--search)) +Optional: - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.compute` +- **include_zero** (Boolean) Always include zero or fit the axis to the data range. +- **label** (String) The label of the axis to display on the graph. +- **max** (String) Specify the maximum value to show on the Y-axis. +- **min** (String) Specify the minimum value to show on the Y-axis. +- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. -Required: -- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. + +### Nested Schema for `widget.scatterplot_definition.yaxis` Optional: -- **interval** (Number) A time interval in milliseconds. -- **metric** (String) The measurable attribute to compute. +- **include_zero** (Boolean) Always include zero or fit the axis to the data range. +- **label** (String) The label of the axis to display on the graph. +- **max** (String) Specify the maximum value to show on the Y-axis. +- **min** (String) Specify the minimum value to show on the Y-axis. +- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by` + + +### Nested Schema for `widget.service_level_objective_definition` Required: -- **facet** (String) The event facet. +- **slo_id** (String) The ID of the service level objective used by the widget. +- **time_windows** (List of String) A list of time windows to display in the widget. Valid values are `7d`, `30d`, `90d`, `week_to_date`, `previous_week`, `month_to_date`, `previous_month`, `global_time`. +- **view_mode** (String) The view mode for the widget. Valid values are `overall`, `component`, `both`. +- **view_type** (String) The type of view to use when displaying the widget. Only `detail` is supported. Optional: -- **limit** (Number) The number of groups to return. -- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--scatterplot_table--query--event_query--group_by--sort)) +- **global_time_target** (String) The global time target of the widget. +- **show_error_budget** (Boolean) Whether to show the error budget or not. +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.group_by.sort` + + +### Nested Schema for `widget.servicemap_definition` Required: -- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. +- **filters** (List of String) Your environment and primary tag (or `*` if enabled for your account). +- **service** (String) The ID of the service to map. Optional: -- **metric** (String) The metric used for sorting group by results. -- **order** (String) Direction of sort. Valid values are `asc`, `desc`. - +- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--servicemap_definition--custom_link)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title (defaults to 16). + +### Nested Schema for `widget.servicemap_definition.custom_link` - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.event_query.search` +Optional: -Required: +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. -- **query** (String) The events search string. + +### Nested Schema for `widget.sunburst_definition` - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.metric_query` +Optional: -Required: +- **custom_link** (Block List) Nested block describing a custom link. Multiple `custom_link` blocks are allowed with the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--custom_link)) +- **hide_total** (Boolean) Whether or not to show the total value in the widget. +- **legend_inline** (Block List) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_inline)) +- **legend_table** (Block List) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_table)) +- **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. +- **request** (Block List) Nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed with the structure below (exactly one of `q`, `log_query` or `rum_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--sunburst_definition--request)) +- **title** (String) The title of the widget. +- **title_align** (String) The alignment of the widget's title. One of `left`, `center`, or `right`. Valid values are `center`, `left`, `right`. +- **title_size** (String) The size of the widget's title. Default is 16. -- **name** (String) The name of the query for use in formulas. -- **query** (String) The metrics query definition. + +### Nested Schema for `widget.sunburst_definition.custom_link` Optional: -- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. -- **data_source** (String) The data source for metrics queries. +- **is_hidden** (Boolean) The flag for toggling context menu link visibility. +- **label** (String) The label for the custom link URL. +- **link** (String) The URL of the custom link. +- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. - -### Nested Schema for `widget.scatterplot_definition.request.scatterplot_table.query.process_query` + +### Nested Schema for `widget.sunburst_definition.legend_inline` Required: -- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. -- **metric** (String) The process metric name. -- **name** (String) The name of query for use in formulas. +- **type** (String) The type of legend (table or inline). Optional: -- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. -- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. -- **limit** (Number) The number of hits to return. -- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. -- **tag_filters** (List of String) An array of tags to filter by. -- **text_filter** (String) The text to use as a filter. +- **hide_percent** (Boolean) Whether to hide the percentages of the groups. +- **hide_value** (Boolean) Whether to hide the values of the groups. + +### Nested Schema for `widget.sunburst_definition.legend_table` +Required: + +- **type** (String) The type of legend (table or inline). - -### Nested Schema for `widget.scatterplot_definition.request.x` + + +### Nested Schema for `widget.sunburst_definition.request` Optional: -- **aggregator** (String) Aggregator used for the request. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--process_query)) +- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--apm_query)) +- **audit_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--audit_query)) +- **formula** (Block List) (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--formula)) +- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--log_query)) +- **network_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--network_query)) +- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--process_query)) - **q** (String) The metric query to use for this widget. -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query)) +- **query** (Block List) (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query)) +- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--rum_query)) +- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--security_query)) - -### Nested Schema for `widget.scatterplot_definition.request.x.apm_query` + +### Nested Schema for `widget.sunburst_definition.request.apm_query` Required: @@ -10218,13 +11564,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--apm_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--apm_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--apm_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.apm_query.compute_query` Required: @@ -10236,17 +11582,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.group_by` + +### Nested Schema for `widget.sunburst_definition.request.apm_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--apm_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.apm_query.group_by.sort_query` Required: @@ -10259,8 +11605,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.apm_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.apm_query.multi_compute` Required: @@ -10273,8 +11619,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.log_query` + +### Nested Schema for `widget.sunburst_definition.request.audit_query` Required: @@ -10282,13 +11628,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--audit_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--audit_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--audit_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.x.log_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.audit_query.compute_query` Required: @@ -10300,17 +11646,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.x.log_query.group_by` + +### Nested Schema for `widget.sunburst_definition.request.audit_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--log_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--audit_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.x.log_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.audit_query.group_by.sort_query` Required: @@ -10323,8 +11669,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.log_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.audit_query.multi_compute` Required: @@ -10337,86 +11683,51 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.process_query` - -Required: - -- **metric** (String) Your chosen metric. - -Optional: - -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. - - - -### Nested Schema for `widget.scatterplot_definition.request.x.rum_query` - -Required: - -- **index** (String) The name of the index to query. - -Optional: - -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--multi_compute)) -- **search_query** (String) The search query to use. - - -### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.formula` Required: -- **aggregation** (String) The aggregation method. - -Optional: - -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. - - - -### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.group_by` +- **formula_expression** (String) A string expression built from queries, formulas, and functions. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--rum_query--group_by--sort_query)) +- **alias** (String) An expression alias. +- **cell_display_mode** (String) A list of display modes for each table cell. Valid values are `number`, `bar`. +- **conditional_formats** (Block List) Conditional formats allow you to set the color of your widget content or background depending on the rule applied to your data. Multiple `conditional_formats` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--formula--conditional_formats)) +- **limit** (Block List, Max: 1) The options for limiting results returned. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--formula--limit)) - -### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.formula.conditional_formats` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. - -Optional: - -- **facet** (String) The facet name. - +- **comparator** (String) The comparator to use. Valid values are `>`, `>=`, `<`, `<=`. +- **palette** (String) The color palette to apply. Valid values are `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`. +- **value** (Number) A value for the comparator. +Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.rum_query.multi_compute` +- **custom_bg_color** (String) The color palette to apply to the background, same values available as palette. +- **custom_fg_color** (String) The color palette to apply to the foreground, same values available as palette. +- **hide_value** (Boolean) Setting this to True hides values. +- **image_url** (String) Displays an image as the background. +- **metric** (String) The metric from the request to correlate with this conditional format. +- **timeframe** (String) Defines the displayed timeframe. -Required: -- **aggregation** (String) The aggregation method. + +### Nested Schema for `widget.sunburst_definition.request.formula.limit` Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **count** (Number) The number of results to return +- **order** (String) The direction of the sort. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.scatterplot_definition.request.x.security_query` + +### Nested Schema for `widget.sunburst_definition.request.log_query` Required: @@ -10424,13 +11735,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--log_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--log_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--log_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.x.security_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.log_query.compute_query` Required: @@ -10442,17 +11753,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.x.security_query.group_by` + +### Nested Schema for `widget.sunburst_definition.request.log_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--x--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--log_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.x.security_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.log_query.group_by.sort_query` Required: @@ -10465,8 +11776,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.x.security_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.log_query.multi_compute` Required: @@ -10479,22 +11790,8 @@ Optional: - - -### Nested Schema for `widget.scatterplot_definition.request.y` - -Optional: - -- **aggregator** (String) Aggregator used for the request. Valid values are `avg`, `last`, `max`, `min`, `sum`, `percentile`. -- **apm_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query)) -- **log_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query)) -- **process_query** (Block List, Max: 1) The process query to use in the widget. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--process_query)) -- **q** (String) The metric query to use for this widget. -- **rum_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query)) -- **security_query** (Block List, Max: 1) The query to use for this widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query)) - - -### Nested Schema for `widget.scatterplot_definition.request.y.apm_query` + +### Nested Schema for `widget.sunburst_definition.request.network_query` Required: @@ -10502,13 +11799,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--network_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--network_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--network_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.network_query.compute_query` Required: @@ -10520,17 +11817,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.group_by` + +### Nested Schema for `widget.sunburst_definition.request.network_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--apm_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--network_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.network_query.group_by.sort_query` Required: @@ -10543,8 +11840,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.y.apm_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.network_query.multi_compute` Required: @@ -10557,150 +11854,170 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.y.log_query` + +### Nested Schema for `widget.sunburst_definition.request.process_query` Required: -- **index** (String) The name of the index to query. +- **metric** (String) Your chosen metric. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--multi_compute)) -- **search_query** (String) The search query to use. - - -### Nested Schema for `widget.scatterplot_definition.request.y.log_query.compute_query` +- **filter_by** (List of String) A list of processes. +- **limit** (Number) The max number of items in the filter list. +- **search_by** (String) Your chosen search term. -Required: -- **aggregation** (String) The aggregation method. + +### Nested Schema for `widget.sunburst_definition.request.query` Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **apm_dependency_stats_query** (Block List, Max: 1) The APM Dependency Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--apm_dependency_stats_query)) +- **apm_resource_stats_query** (Block List, Max: 1) The APM Resource Stats query using formulas and functions. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--apm_resource_stats_query)) +- **event_query** (Block List, Max: 1) A timeseries formula and functions events query. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--event_query)) +- **metric_query** (Block List, Max: 1) A timeseries formula and functions metrics query. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--metric_query)) +- **process_query** (Block List, Max: 1) The process query using formulas and functions. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--process_query)) + +### Nested Schema for `widget.sunburst_definition.request.query.apm_dependency_stats_query` - -### Nested Schema for `widget.scatterplot_definition.request.y.log_query.group_by` +Required: + +- **data_source** (String) The data source for APM Dependency Stats queries. Valid values are `apm_dependency_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **operation_name** (String) Name of operation on service. +- **resource_name** (String) APM resource. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `avg_duration`, `avg_root_duration`, `avg_spans_per_trace`, `error_rate`, `pct_exec_time`, `pct_of_traces`, `total_traces_count`. Optional: -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--log_query--group_by--sort_query)) +- **is_upstream** (Boolean) Determines whether stats for upstream or downstream dependencies should be queried. +- **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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. - -### Nested Schema for `widget.scatterplot_definition.request.y.log_query.group_by.sort_query` + + +### Nested Schema for `widget.sunburst_definition.request.query.apm_resource_stats_query` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **data_source** (String) The data source for APM Resource Stats queries. Valid values are `apm_resource_stats`. +- **env** (String) APM Environment. +- **name** (String) The name of query for use in formulas. +- **service** (String) APM service. +- **stat** (String) APM statistic. Valid values are `errors`, `error_rate`, `hits`, `latency_avg`, `latency_max`, `latency_p50`, `latency_p75`, `latency_p90`, `latency_p95`, `latency_p99`. Optional: -- **facet** (String) The facet name. - +- **group_by** (List of String) Array of fields to group results by. +- **operation_name** (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. +- **primary_tag_value** (String) Filter APM data by the second primary tag. `primary_tag_name` must also be specified. +- **resource_name** (String) APM resource. - -### Nested Schema for `widget.scatterplot_definition.request.y.log_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.query.event_query` Required: -- **aggregation** (String) The aggregation method. +- **compute** (Block List, Min: 1) The compute options. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--event_query--compute)) +- **data_source** (String) The data source for event platform-based queries. Valid values are `logs`, `spans`, `network`, `rum`, `security_signals`, `profiles`, `audit`, `events`. +- **name** (String) The name of query for use in formulas. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. - - +- **group_by** (Block List) Group by options. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--event_query--group_by)) +- **indexes** (List of String) An array of index names to query in the stream. +- **search** (Block List, Max: 1) The search options. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--event_query--search)) - -### Nested Schema for `widget.scatterplot_definition.request.y.process_query` + +### Nested Schema for `widget.sunburst_definition.request.query.event_query.compute` Required: -- **metric** (String) Your chosen metric. +- **aggregation** (String) The aggregation methods for event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. Optional: -- **filter_by** (List of String) A list of processes. -- **limit** (Number) The max number of items in the filter list. -- **search_by** (String) Your chosen search term. +- **interval** (Number) A time interval in milliseconds. +- **metric** (String) The measurable attribute to compute. - -### Nested Schema for `widget.scatterplot_definition.request.y.rum_query` + +### Nested Schema for `widget.sunburst_definition.request.query.event_query.group_by` Required: -- **index** (String) The name of the index to query. +- **facet** (String) The event facet. Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--multi_compute)) -- **search_query** (String) The search query to use. +- **limit** (Number) The number of groups to return. +- **sort** (Block List, Max: 1) The options for sorting group by results. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--query--event_query--group_by--sort)) - -### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.query.event_query.group_by.sort` Required: -- **aggregation** (String) The aggregation method. +- **aggregation** (String) The aggregation methods for the event platform queries. Valid values are `count`, `cardinality`, `median`, `pc75`, `pc90`, `pc95`, `pc98`, `pc99`, `sum`, `min`, `max`, `avg`. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **metric** (String) The metric used for sorting group by results. +- **order** (String) Direction of sort. Valid values are `asc`, `desc`. - -### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.group_by` -Optional: + +### Nested Schema for `widget.sunburst_definition.request.query.event_query.search` -- **facet** (String) The facet name. -- **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--rum_query--group_by--sort_query)) +Required: - -### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.group_by.sort_query` +- **query** (String) The events search string. + + + + +### Nested Schema for `widget.sunburst_definition.request.query.metric_query` Required: -- **aggregation** (String) The aggregation method. -- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. +- **name** (String) The name of the query for use in formulas. +- **query** (String) The metrics query definition. Optional: -- **facet** (String) The facet name. - +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **data_source** (String) The data source for metrics queries. - -### Nested Schema for `widget.scatterplot_definition.request.y.rum_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.query.process_query` Required: -- **aggregation** (String) The aggregation method. +- **data_source** (String) The data source for process queries. Valid values are `process`, `container`. +- **metric** (String) The process metric name. +- **name** (String) The name of query for use in formulas. Optional: -- **facet** (String) The facet name. -- **interval** (Number) Define the time interval in seconds. +- **aggregator** (String) The aggregation methods available for metrics queries. Valid values are `avg`, `min`, `max`, `sum`, `last`, `area`, `l2norm`, `percentile`. +- **is_normalized_cpu** (Boolean) Whether to normalize the CPU percentages. +- **limit** (Number) The number of hits to return. +- **sort** (String) The direction of the sort. Valid values are `asc`, `desc`. +- **tag_filters** (List of String) An array of tags to filter by. +- **text_filter** (String) The text to use as a filter. - -### Nested Schema for `widget.scatterplot_definition.request.y.security_query` + +### Nested Schema for `widget.sunburst_definition.request.rum_query` Required: @@ -10708,13 +12025,13 @@ Required: Optional: -- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--compute_query)) -- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--group_by)) -- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--multi_compute)) +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--rum_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--rum_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--rum_query--multi_compute)) - **search_query** (String) The search query to use. - -### Nested Schema for `widget.scatterplot_definition.request.y.security_query.compute_query` + +### Nested Schema for `widget.sunburst_definition.request.rum_query.compute_query` Required: @@ -10726,17 +12043,17 @@ Optional: - **interval** (Number) Define the time interval in seconds. - -### Nested Schema for `widget.scatterplot_definition.request.y.security_query.group_by` + +### Nested Schema for `widget.sunburst_definition.request.rum_query.group_by` Optional: - **facet** (String) The facet name. - **limit** (Number) The maximum number of items in the group. -- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--scatterplot_definition--request--y--security_query--group_by--sort_query)) +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--rum_query--group_by--sort_query)) - -### Nested Schema for `widget.scatterplot_definition.request.y.security_query.group_by.sort_query` + +### Nested Schema for `widget.sunburst_definition.request.rum_query.group_by.sort_query` Required: @@ -10749,8 +12066,8 @@ Optional: - -### Nested Schema for `widget.scatterplot_definition.request.y.security_query.multi_compute` + +### Nested Schema for `widget.sunburst_definition.request.rum_query.multi_compute` Required: @@ -10763,76 +12080,69 @@ Optional: + +### Nested Schema for `widget.sunburst_definition.request.security_query` +Required: - -### Nested Schema for `widget.scatterplot_definition.xaxis` +- **index** (String) The name of the index to query. Optional: -- **include_zero** (Boolean) Always include zero or fit the axis to the data range. -- **label** (String) The label of the axis to display on the graph. -- **max** (String) Specify the maximum value to show on the Y-axis. -- **min** (String) Specify the minimum value to show on the Y-axis. -- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. +- **compute_query** (Block List, Max: 1) `compute_query` or `multi_compute` is required. The map keys are listed below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--security_query--compute_query)) +- **group_by** (Block List) Multiple `group_by` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--security_query--group_by)) +- **multi_compute** (Block List) `compute_query` or `multi_compute` is required. Multiple `multi_compute` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--security_query--multi_compute)) +- **search_query** (String) The search query to use. + +### Nested Schema for `widget.sunburst_definition.request.security_query.compute_query` - -### Nested Schema for `widget.scatterplot_definition.yaxis` +Required: + +- **aggregation** (String) The aggregation method. Optional: -- **include_zero** (Boolean) Always include zero or fit the axis to the data range. -- **label** (String) The label of the axis to display on the graph. -- **max** (String) Specify the maximum value to show on the Y-axis. -- **min** (String) Specify the minimum value to show on the Y-axis. -- **scale** (String) Specify the scale type, options: `linear`, `log`, `pow`, `sqrt`. +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. + +### Nested Schema for `widget.sunburst_definition.request.security_query.group_by` - -### Nested Schema for `widget.service_level_objective_definition` +Optional: + +- **facet** (String) The facet name. +- **limit** (Number) The maximum number of items in the group. +- **sort_query** (Block List, Max: 1) A list of exactly one element describing the sort query to use. (see [below for nested schema](#nestedblock--widget--sunburst_definition--request--security_query--group_by--sort_query)) + + +### Nested Schema for `widget.sunburst_definition.request.security_query.group_by.sort_query` Required: -- **slo_id** (String) The ID of the service level objective used by the widget. -- **time_windows** (List of String) A list of time windows to display in the widget. Valid values are `7d`, `30d`, `90d`, `week_to_date`, `previous_week`, `month_to_date`, `previous_month`, `global_time`. -- **view_mode** (String) The view mode for the widget. Valid values are `overall`, `component`, `both`. -- **view_type** (String) The type of view to use when displaying the widget. Only `detail` is supported. +- **aggregation** (String) The aggregation method. +- **order** (String) Widget sorting methods. Valid values are `asc`, `desc`. Optional: -- **global_time_target** (String) The global time target of the widget. -- **show_error_budget** (Boolean) Whether to show the error budget or not. -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). +- **facet** (String) The facet name. - -### Nested Schema for `widget.servicemap_definition` + + +### Nested Schema for `widget.sunburst_definition.request.security_query.multi_compute` Required: -- **filters** (List of String) Your environment and primary tag (or `*` if enabled for your account). -- **service** (String) The ID of the service to map. +- **aggregation** (String) The aggregation method. Optional: -- **custom_link** (Block List) A nested block describing a custom link. Multiple `custom_link` blocks are allowed using the structure below. (see [below for nested schema](#nestedblock--widget--servicemap_definition--custom_link)) -- **title** (String) The title of the widget. -- **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. -- **title_size** (String) The size of the widget's title (defaults to 16). - - -### Nested Schema for `widget.servicemap_definition.custom_link` +- **facet** (String) The facet name. +- **interval** (Number) Define the time interval in seconds. -Optional: -- **is_hidden** (Boolean) The flag for toggling context menu link visibility. -- **label** (String) The label for the custom link URL. -- **link** (String) The URL of the custom link. -- **override_label** (String) The label id that refers to a context menu link item. When override_label is provided, the client request omits the label field. From feb1df6d33a4e7e6c2de206012d6a6a57912591b Mon Sep 17 00:00:00 2001 From: "david.leonard" Date: Tue, 11 Jan 2022 16:29:47 -0500 Subject: [PATCH 2/4] Regenerate docs --- docs/resources/dashboard.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index 4b1660a45..e9553b1a5 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -6476,7 +6476,7 @@ Optional: Required: -- **type** (String) The type of legend (table or inline). +- **type** (String) The type of legend (table or none). Valid values are `inline`, `automatic`. Optional: @@ -6489,7 +6489,7 @@ Optional: Required: -- **type** (String) The type of legend (table or inline). +- **type** (String) The type of legend (automatic or inline). Valid values are `table`, `none`. @@ -11523,7 +11523,7 @@ Optional: Required: -- **type** (String) The type of legend (table or inline). +- **type** (String) The type of legend (table or none). Valid values are `inline`, `automatic`. Optional: @@ -11536,7 +11536,7 @@ Optional: Required: -- **type** (String) The type of legend (table or inline). +- **type** (String) The type of legend (automatic or inline). Valid values are `table`, `none`. From c858d2a30419093cefa29d8ef2e9dfb1902678d9 Mon Sep 17 00:00:00 2001 From: "david.leonard" Date: Wed, 12 Jan 2022 11:40:18 -0500 Subject: [PATCH 3/4] Regenerate docs --- datadog/resource_datadog_dashboard.go | 4 ++-- docs/resources/dashboard.md | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/datadog/resource_datadog_dashboard.go b/datadog/resource_datadog_dashboard.go index 68dfb8ee5..7cc6ae589 100644 --- a/datadog/resource_datadog_dashboard.go +++ b/datadog/resource_datadog_dashboard.go @@ -829,7 +829,7 @@ func getNonGroupWidgetSchema() map[string]*schema.Schema { Type: schema.TypeList, Optional: true, MaxItems: 1, - Description: "The definition for a Sunburst widget", + Description: "The definition for a Sunburst widget.", Elem: &schema.Resource{ Schema: getSunburstDefinitionschema(), }, @@ -4842,7 +4842,7 @@ func getTimeseriesDefinitionSchema() map[string]*schema.Schema { }, }, "yaxis": { - Description: "A nested block describing the Y-Axis Controls. The structure of this block is described below", + Description: "A nested block describing the Y-Axis Controls. The structure of this block is described below.", Type: schema.TypeList, MaxItems: 1, Optional: true, diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index e9553b1a5..c1e43f378 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -764,7 +764,7 @@ Optional: - **scatterplot_definition** (Block List, Max: 1) The definition for a Scatterplot widget. (see [below for nested schema](#nestedblock--widget--scatterplot_definition)) - **service_level_objective_definition** (Block List, Max: 1) The definition for a Service Level Objective widget. (see [below for nested schema](#nestedblock--widget--service_level_objective_definition)) - **servicemap_definition** (Block List, Max: 1) The definition for a Service Map widget. (see [below for nested schema](#nestedblock--widget--servicemap_definition)) -- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget (see [below for nested schema](#nestedblock--widget--sunburst_definition)) +- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget. (see [below for nested schema](#nestedblock--widget--sunburst_definition)) - **timeseries_definition** (Block List, Max: 1) The definition for a Timeseries widget. (see [below for nested schema](#nestedblock--widget--timeseries_definition)) - **toplist_definition** (Block List, Max: 1) The definition for a Toplist widget. (see [below for nested schema](#nestedblock--widget--toplist_definition)) - **trace_service_definition** (Block List, Max: 1) The definition for a Trace Service widget. (see [below for nested schema](#nestedblock--widget--trace_service_definition)) @@ -2103,7 +2103,7 @@ Optional: - **scatterplot_definition** (Block List, Max: 1) The definition for a Scatterplot widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--scatterplot_definition)) - **service_level_objective_definition** (Block List, Max: 1) The definition for a Service Level Objective widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--service_level_objective_definition)) - **servicemap_definition** (Block List, Max: 1) The definition for a Service Map widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--servicemap_definition)) -- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition)) +- **sunburst_definition** (Block List, Max: 1) The definition for a Sunburst widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition)) - **timeseries_definition** (Block List, Max: 1) The definition for a Timeseries widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition)) - **toplist_definition** (Block List, Max: 1) The definition for a Toplist widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--toplist_definition)) - **trace_service_definition** (Block List, Max: 1) The definition for a Trace Service widget. (see [below for nested schema](#nestedblock--widget--group_definition--widget--trace_service_definition)) @@ -7117,7 +7117,7 @@ Optional: - **title** (String) The title of the widget. - **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. - **title_size** (String) The size of the widget's title (defaults to 16). -- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--yaxis)) +- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--timeseries_definition--yaxis)) ### Nested Schema for `widget.group_definition.widget.timeseries_definition.custom_link` @@ -12164,7 +12164,7 @@ Optional: - **title** (String) The title of the widget. - **title_align** (String) The alignment of the widget's title. Valid values are `center`, `left`, `right`. - **title_size** (String) The size of the widget's title (defaults to 16). -- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below (see [below for nested schema](#nestedblock--widget--timeseries_definition--yaxis)) +- **yaxis** (Block List, Max: 1) A nested block describing the Y-Axis Controls. The structure of this block is described below. (see [below for nested schema](#nestedblock--widget--timeseries_definition--yaxis)) ### Nested Schema for `widget.timeseries_definition.custom_link` From e7a56a1c0fa6d6fa199156a143910a6e33000b79 Mon Sep 17 00:00:00 2001 From: "david.leonard" Date: Wed, 12 Jan 2022 14:06:31 -0500 Subject: [PATCH 4/4] Address PR feedback and regenerate docs --- datadog/resource_datadog_dashboard.go | 6 ++++-- docs/resources/dashboard.md | 16 ++++++++-------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/datadog/resource_datadog_dashboard.go b/datadog/resource_datadog_dashboard.go index 7cc6ae589..ec95275a6 100644 --- a/datadog/resource_datadog_dashboard.go +++ b/datadog/resource_datadog_dashboard.go @@ -5048,10 +5048,11 @@ func getSunburstDefinitionschema() map[string]*schema.Schema { Description: "Used to configure the inline legend. Cannot be used in conjunction with legend_table.", Type: schema.TypeList, Optional: true, + MaxItems: 1, Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "type": { - Description: "The type of legend (table or none).", + Description: "The type of legend (inline or automatic).", Type: schema.TypeString, ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSunburstWidgetLegendInlineAutomaticTypeFromValue), Required: true, @@ -5073,10 +5074,11 @@ func getSunburstDefinitionschema() map[string]*schema.Schema { Description: "Used to configure the table legend. Cannot be used in conjunction with legend_inline.", Type: schema.TypeList, Optional: true, + MaxItems: 1, Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "type": { - Description: "The type of legend (automatic or inline).", + Description: "The type of legend (table or none).", Type: schema.TypeString, ValidateDiagFunc: validators.ValidateEnumValue(datadogV1.NewSunburstWidgetLegendTableTypeFromValue), Required: true, diff --git a/docs/resources/dashboard.md b/docs/resources/dashboard.md index c1e43f378..7a64eee96 100644 --- a/docs/resources/dashboard.md +++ b/docs/resources/dashboard.md @@ -6452,8 +6452,8 @@ Optional: - **custom_link** (Block List) Nested block describing a custom link. Multiple `custom_link` blocks are allowed with the structure below. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--custom_link)) - **hide_total** (Boolean) Whether or not to show the total value in the widget. -- **legend_inline** (Block List) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_inline)) -- **legend_table** (Block List) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_table)) +- **legend_inline** (Block List, Max: 1) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_inline)) +- **legend_table** (Block List, Max: 1) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--legend_table)) - **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. - **request** (Block List) Nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed with the structure below (exactly one of `q`, `log_query` or `rum_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--group_definition--widget--sunburst_definition--request)) - **title** (String) The title of the widget. @@ -6476,7 +6476,7 @@ Optional: Required: -- **type** (String) The type of legend (table or none). Valid values are `inline`, `automatic`. +- **type** (String) The type of legend (inline or automatic). Valid values are `inline`, `automatic`. Optional: @@ -6489,7 +6489,7 @@ Optional: Required: -- **type** (String) The type of legend (automatic or inline). Valid values are `table`, `none`. +- **type** (String) The type of legend (table or none). Valid values are `table`, `none`. @@ -11499,8 +11499,8 @@ Optional: - **custom_link** (Block List) Nested block describing a custom link. Multiple `custom_link` blocks are allowed with the structure below. (see [below for nested schema](#nestedblock--widget--sunburst_definition--custom_link)) - **hide_total** (Boolean) Whether or not to show the total value in the widget. -- **legend_inline** (Block List) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_inline)) -- **legend_table** (Block List) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_table)) +- **legend_inline** (Block List, Max: 1) Used to configure the inline legend. Cannot be used in conjunction with legend_table. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_inline)) +- **legend_table** (Block List, Max: 1) Used to configure the table legend. Cannot be used in conjunction with legend_inline. (see [below for nested schema](#nestedblock--widget--sunburst_definition--legend_table)) - **live_span** (String) The timeframe to use when displaying the widget. Valid values are `1m`, `5m`, `10m`, `15m`, `30m`, `1h`, `4h`, `1d`, `2d`, `1w`, `1mo`, `3mo`, `6mo`, `1y`, `alert`. - **request** (Block List) Nested block describing the request to use when displaying the widget. Multiple `request` blocks are allowed with the structure below (exactly one of `q`, `log_query` or `rum_query` is required within the `request` block). (see [below for nested schema](#nestedblock--widget--sunburst_definition--request)) - **title** (String) The title of the widget. @@ -11523,7 +11523,7 @@ Optional: Required: -- **type** (String) The type of legend (table or none). Valid values are `inline`, `automatic`. +- **type** (String) The type of legend (inline or automatic). Valid values are `inline`, `automatic`. Optional: @@ -11536,7 +11536,7 @@ Optional: Required: -- **type** (String) The type of legend (automatic or inline). Valid values are `table`, `none`. +- **type** (String) The type of legend (table or none). Valid values are `table`, `none`.