From a1175740a2f0941b7ed50600e0cc8e8b5748488f Mon Sep 17 00:00:00 2001 From: Archana A Date: Tue, 9 Jun 2026 10:37:46 -0400 Subject: [PATCH 1/5] [DASHB-987] Add search syntax section to Dashboard List docs Document the full query syntax supported by the v2 dashboard search: free-text search, key:value filters, boolean operators, range comparisons, wildcards, quoted phrases, and the Favorites UI toggle. --- content/en/dashboards/list/_index.md | 62 ++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index f8b689d0a52..3c1688a011c 100644 --- a/content/en/dashboards/list/_index.md +++ b/content/en/dashboards/list/_index.md @@ -86,6 +86,68 @@ Use the preset {{< ui >}}Recently Deleted{{< /ui >}} list to restore deleted das {{< img src="dashboards/list/recently_deleted_restore.png" alt="Restore deleted dashboard on the Recently Deleted list" style="width:100%;">}} +## Search syntax + +Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, boolean operators, and range comparisons. + +### Free-text search + +Type one or more words to search across dashboard titles, descriptions, author names, tags, and widget content. + +- **Single token**: `redis` matches dashboards with "redis" in the title, author, tags, or widgets. +- **Multiple tokens**: `redis postgres` is equivalent to `redis AND postgres`—both tokens must appear. +- **Quoted phrase**: `"web latency"` matches that exact phrase. +- **Wildcard**: `elastic*` matches "elasticsearch", "elastic-search", and similar. + +### Key:value filters + +Narrow results to a specific field using `field:value` syntax. + +| Filter | Description | Example | +|--------|-------------|---------| +| `author:` | Dashboards whose author handle or display name matches | `author:brandon` | +| `title:` | Dashboard title | `title:elasticsearch` | +| `description:` | Dashboard description | `description:latency` | +| `team:` | Team tag | `team:dashboards-backend` | +| `type:` | Dashboard type. Use `custom`, `integration`, or concrete values such as `custom_timeboard`, `custom_screenboard`, `integration_timeboard`, `integration_screenboard`. | `type:integration` | +| `is_shared:true` | Dashboards with link sharing enabled | `is_shared:true` | +| `popularity:` | Popularity score (0–1) | `popularity:>=0.5` | +| `widgets.count:` | Number of widgets | `widgets.count:<5` | +| `widgets.title:` | Widget title | `widgets.title:cpu` | +| `widgets.type:` | Widget type | `widgets.type:geomap` | +| `widgets.metrics:` | Metric used in a widget | `widgets.metrics:system.cpu.user` | +| `template_variables.name:` | Template variable name | `template_variables.name:service` | +| `template_variables.prefix:` | Template variable prefix | `template_variables.prefix:env` | +| `template_variables.defaults:` | Template variable default value | `template_variables.defaults:prod` | +| `template_variables.available_values:` | Available template variable value | `template_variables.available_values:us-east` | + +**Note**: `team:` works as a tag filter. Any tag in `key:value` format can be searched the same way—for example, `env:prod` or `service:web`. + +### Boolean operators + +Combine filters with `AND`, `OR`, and `NOT` (case-sensitive). The `-` prefix and `!` prefix are equivalent to `NOT`. + +| Operator | Description | Example | +|----------|-------------|---------| +| `AND` | Both conditions must match | `type:integration AND team:platform` | +| `OR` | Either condition must match | `k8s OR kubernetes` | +| `NOT` / `-` / `!` | Exclude matching dashboards | `NOT type:integration` | +| `field:(A OR B)` | Match either value for the same field | `team:(backend OR frontend)` | + +### Range operators + +Use `<`, `>`, `<=`, and `>=` with numeric fields. + +| Filter | Description | Example | +|--------|-------------|---------| +| `widgets.count:=N` | N or more widgets | `widgets.count:>=10` | +| `popularity:>=N` | Popularity at or above threshold | `popularity:>=0.2` | + +### Favorites + +Use the {{< ui >}}Starred{{< /ui >}} toggle above the dashboard table to show only dashboards you have starred. This is separate from the search bar. + ## Further Reading {{< partial name="whats-next/whats-next.html" >}} From f51d5cabe99004b10685e9d01d335708aa5290bb Mon Sep 17 00:00:00 2001 From: Archana A Date: Tue, 9 Jun 2026 11:10:35 -0400 Subject: [PATCH 2/5] [DASHB-987] Refine search syntax section and remove stale preset list entry - Remove Frequently Viewed By You from preset lists (no longer supported) - Add New callout banner to Search syntax section - Add favorites:true to key:value filters table - Remove team: tag note - Remove Favorites UI toggle subsection (replaced by favorites:true syntax) --- content/en/dashboards/list/_index.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index 3c1688a011c..403e4bd1d3f 100644 --- a/content/en/dashboards/list/_index.md +++ b/content/en/dashboards/list/_index.md @@ -76,7 +76,6 @@ Preset lists are out-of-the-box dashboard lists in Datadog: | All Integrations | Automatic dashboards created by Datadog when you install an integration. | | All Shared | Dashboards with authenticated or public link sharing enabled. | | Created By You | Custom dashboards created by the current user. | -| Frequently Viewed By You | All dashboards frequently viewed by the current user. | | Recently Deleted | Dashboards deleted within the last 30 days. [Restore deleted dashboards](#restore-deleted-dashboards) from this list.| | Security and Compliance | Out-of-the-box Security dashboards. | @@ -88,6 +87,10 @@ Use the preset {{< ui >}}Recently Deleted{{< /ui >}} list to restore deleted das ## Search syntax +{{< callout url="#" btn_hidden="true" header="New" >}} +Dashboard search syntax is available on the updated Dashboard List page. +{{< /callout >}} + Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, boolean operators, and range comparisons. ### Free-text search @@ -109,6 +112,7 @@ Narrow results to a specific field using `field:value` syntax. | `title:` | Dashboard title | `title:elasticsearch` | | `description:` | Dashboard description | `description:latency` | | `team:` | Team tag | `team:dashboards-backend` | +| `favorites:true` | Dashboards you have starred | `favorites:true` | | `type:` | Dashboard type. Use `custom`, `integration`, or concrete values such as `custom_timeboard`, `custom_screenboard`, `integration_timeboard`, `integration_screenboard`. | `type:integration` | | `is_shared:true` | Dashboards with link sharing enabled | `is_shared:true` | | `popularity:` | Popularity score (0–1) | `popularity:>=0.5` | @@ -121,8 +125,6 @@ Narrow results to a specific field using `field:value` syntax. | `template_variables.defaults:` | Template variable default value | `template_variables.defaults:prod` | | `template_variables.available_values:` | Available template variable value | `template_variables.available_values:us-east` | -**Note**: `team:` works as a tag filter. Any tag in `key:value` format can be searched the same way—for example, `env:prod` or `service:web`. - ### Boolean operators Combine filters with `AND`, `OR`, and `NOT` (case-sensitive). The `-` prefix and `!` prefix are equivalent to `NOT`. @@ -144,10 +146,6 @@ Use `<`, `>`, `<=`, and `>=` with numeric fields. | `widgets.count:>=N` | N or more widgets | `widgets.count:>=10` | | `popularity:>=N` | Popularity at or above threshold | `popularity:>=0.2` | -### Favorites - -Use the {{< ui >}}Starred{{< /ui >}} toggle above the dashboard table to show only dashboards you have starred. This is separate from the search bar. - ## Further Reading {{< partial name="whats-next/whats-next.html" >}} From b8b66148ec7be9292a7694520e0a4257c223130f Mon Sep 17 00:00:00 2001 From: Archana A Date: Tue, 9 Jun 2026 15:42:40 -0400 Subject: [PATCH 3/5] Apply suggestions from code review Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Rosa Trieu <107086888+rtrieu@users.noreply.github.com> --- content/en/dashboards/list/_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index 403e4bd1d3f..35336063f72 100644 --- a/content/en/dashboards/list/_index.md +++ b/content/en/dashboards/list/_index.md @@ -85,10 +85,10 @@ Use the preset {{< ui >}}Recently Deleted{{< /ui >}} list to restore deleted das {{< img src="dashboards/list/recently_deleted_restore.png" alt="Restore deleted dashboard on the Recently Deleted list" style="width:100%;">}} -## Search syntax +## Search syntax {#search-syntax} {{< callout url="#" btn_hidden="true" header="New" >}} -Dashboard search syntax is available on the updated Dashboard List page. +Dashboard search syntax is available on the Dashboard List page. {{< /callout >}} Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, boolean operators, and range comparisons. @@ -104,11 +104,11 @@ Type one or more words to search across dashboard titles, descriptions, author n ### Key:value filters -Narrow results to a specific field using `field:value` syntax. +Narrow results to a specific field using `key:value` syntax. | Filter | Description | Example | |--------|-------------|---------| -| `author:` | Dashboards whose author handle or display name matches | `author:brandon` | +| `author:` | Dashboards whose author handle or display name matches | `author:jane.doe` | | `title:` | Dashboard title | `title:elasticsearch` | | `description:` | Dashboard description | `description:latency` | | `team:` | Team tag | `team:dashboards-backend` | @@ -134,7 +134,7 @@ Combine filters with `AND`, `OR`, and `NOT` (case-sensitive). The `-` prefix and | `AND` | Both conditions must match | `type:integration AND team:platform` | | `OR` | Either condition must match | `k8s OR kubernetes` | | `NOT` / `-` / `!` | Exclude matching dashboards | `NOT type:integration` | -| `field:(A OR B)` | Match either value for the same field | `team:(backend OR frontend)` | +| `field:(A OR B)` | Match either value within a single field | `team:(backend OR frontend)` | ### Range operators From 8dc7660049a7e5501c9935982c7ae60b721c069e Mon Sep 17 00:00:00 2001 From: Archana A Date: Tue, 9 Jun 2026 15:44:28 -0400 Subject: [PATCH 4/5] [DASHB-987] Replace New callout with Preview callout per docs reviewer feedback --- content/en/dashboards/list/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index 35336063f72..a218d612d76 100644 --- a/content/en/dashboards/list/_index.md +++ b/content/en/dashboards/list/_index.md @@ -87,8 +87,8 @@ Use the preset {{< ui >}}Recently Deleted{{< /ui >}} list to restore deleted das ## Search syntax {#search-syntax} -{{< callout url="#" btn_hidden="true" header="New" >}} -Dashboard search syntax is available on the Dashboard List page. +{{< callout url="#" btn_hidden="true" header="Preview" >}} +Dashboard search syntax is in Preview. {{< /callout >}} Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, boolean operators, and range comparisons. From e975ab092945992937c16d1828abade2ba85ad7c Mon Sep 17 00:00:00 2001 From: Archana A Date: Tue, 9 Jun 2026 15:49:16 -0400 Subject: [PATCH 5/5] [DASHB-987] Fix Vale errors: capitalize Boolean, remove en dash --- content/en/dashboards/list/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index a218d612d76..fa8faa32ab7 100644 --- a/content/en/dashboards/list/_index.md +++ b/content/en/dashboards/list/_index.md @@ -91,7 +91,7 @@ Use the preset {{< ui >}}Recently Deleted{{< /ui >}} list to restore deleted das Dashboard search syntax is in Preview. {{< /callout >}} -Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, boolean operators, and range comparisons. +Use the search bar at the top of the Dashboard List page to filter dashboards by name, author, tags, or widget content. The search supports free-text queries, key:value filters, Boolean operators, and range comparisons. ### Free-text search @@ -115,7 +115,7 @@ Narrow results to a specific field using `key:value` syntax. | `favorites:true` | Dashboards you have starred | `favorites:true` | | `type:` | Dashboard type. Use `custom`, `integration`, or concrete values such as `custom_timeboard`, `custom_screenboard`, `integration_timeboard`, `integration_screenboard`. | `type:integration` | | `is_shared:true` | Dashboards with link sharing enabled | `is_shared:true` | -| `popularity:` | Popularity score (0–1) | `popularity:>=0.5` | +| `popularity:` | Popularity score (0 to 1) | `popularity:>=0.5` | | `widgets.count:` | Number of widgets | `widgets.count:<5` | | `widgets.title:` | Widget title | `widgets.title:cpu` | | `widgets.type:` | Widget type | `widgets.type:geomap` |