Skip to content

Add search syntax section to Dashboard List docs #37376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
archana-asokan wants to merge 5 commits into
base: master
Choose a base branch
from
+61 −1
Open

Add search syntax section to Dashboard List docs #37376

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a117574
[DASHB-987] Add search syntax section to Dashboard List docs
archana-asokan Jun 9, 2026
f51d5ca
[DASHB-987] Refine search syntax section and remove stale preset list…
archana-asokan Jun 9, 2026
b8b6614
Apply suggestions from code review
archana-asokan Jun 9, 2026
8dc7660
[DASHB-987] Replace New callout with Preview callout per docs reviewe…
archana-asokan Jun 9, 2026
e975ab0
[DASHB-987] Fix Vale errors: capitalize Boolean, remove en dash
archana-asokan Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 61 additions & 1 deletion content/en/dashboards/list/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand All @@ -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 >}}
Comment thread
rtrieu marked this conversation as resolved.

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:<value>` | Dashboards whose author handle or display name matches | `author:jane.doe` |
| `title:<value>` | Dashboard title | `title:elasticsearch` |
| `description:<value>` | Dashboard description | `description:latency` |
| `team:<value>` | Team tag | `team:dashboards-backend` |
| `favorites:true` | Dashboards you have starred | `favorites:true` |
| `type:<value>` | Dashboard type. Use `custom`, `integration`, or concrete values such as `custom_timeboard`, `custom_screenboard`, `integration_timeboard`, `integration_screenboard`. | `type:integration` |

@github-actions github-actions Bot Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: This cell mixes the high-level values (custom, integration) with four concrete values in a long sentence, making the table row hard to scan. Consider splitting into separate rows, or moving the concrete-value list to a short sentence above the table.

| `is_shared:true` | Dashboards with link sharing enabled | `is_shared:true` |
| `popularity:<range>` | Popularity score (0 to 1) | `popularity:>=0.5` |
| `widgets.count:<range>` | Number of widgets | `widgets.count:<5` |
| `widgets.title:<value>` | Widget title | `widgets.title:cpu` |
| `widgets.type:<value>` | Widget type | `widgets.type:geomap` |
| `widgets.metrics:<value>` | Metric used in a widget | `widgets.metrics:system.cpu.user` |
| `template_variables.name:<value>` | Template variable name | `template_variables.name:service` |
| `template_variables.prefix:<value>` | Template variable prefix | `template_variables.prefix:env` |
| `template_variables.defaults:<value>` | Template variable default value | `template_variables.defaults:prod` |
| `template_variables.available_values:<value>` | 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` | Fewer than N widgets | `widgets.count:<3` |
| `widgets.count:>=N` | N or more widgets | `widgets.count:>=10` |
| `popularity:>=N` | Popularity at or above threshold | `popularity:>=0.2` |

@github-actions github-actions Bot Jun 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: This Range operators table largely duplicates the widgets.count and popularity rows already in the Key:value filters table. Consider either removing those rows from the upper table (and pointing readers here for range syntax) or replacing this table with a short prose paragraph that shows the operator forms once, to avoid two sources of truth.


## Further Reading

{{< partial name="whats-next/whats-next.html" >}}
Expand Down
Loading