diff --git a/content/en/dashboards/list/_index.md b/content/en/dashboards/list/_index.md index f8b689d0a52..fa8faa32ab7 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. | @@ -86,6 +85,67 @@ 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} + +{{< 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. + +### 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 `key:value` syntax. + +| Filter | Description | Example | +|--------|-------------|---------| +| `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` | +| `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 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` | +| `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` | + +### 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 within a single 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` | + ## Further Reading {{< partial name="whats-next/whats-next.html" >}}