@@ -21,6 +21,19 @@ List dashboards
2121- ` -f, --fresh - Bypass cache, re-detect projects, and fetch fresh data `
2222- ` -c, --cursor <value> - Navigate pages: "next", "prev", "first" (or raw cursor string) `
2323
24+ ** Examples:**
25+
26+ ``` bash
27+ # List all dashboards
28+ sentry dashboard list
29+
30+ # Filter by name pattern
31+ sentry dashboard list " Backend*"
32+
33+ # Open dashboard list in browser
34+ sentry dashboard list -w
35+ ```
36+
2437### ` sentry dashboard view <org/project/dashboard...> `
2538
2639View a dashboard
@@ -31,10 +44,32 @@ View a dashboard
3144- ` -r, --refresh <value> - Auto-refresh interval in seconds (default: 60, min: 10) `
3245- ` -t, --period <value> - Time range: "7d", "2026-03-01..2026-04-01", ">=2026-03-01" `
3346
47+ ** Examples:**
48+
49+ ``` bash
50+ # View by title
51+ sentry dashboard view ' Frontend Performance'
52+
53+ # View by ID
54+ sentry dashboard view 12345
55+
56+ # Auto-refresh every 30 seconds
57+ sentry dashboard view " Backend Performance" --refresh 30
58+
59+ # Open in browser
60+ sentry dashboard view 12345 -w
61+ ```
62+
3463### ` sentry dashboard create <org/project/title...> `
3564
3665Create a dashboard
3766
67+ ** Examples:**
68+
69+ ``` bash
70+ sentry dashboard create ' Frontend Performance'
71+ ```
72+
3873### ` sentry dashboard widget add <org/project/dashboard/title...> `
3974
4075Add a widget to a dashboard
@@ -52,6 +87,31 @@ Add a widget to a dashboard
5287- ` --width <value> - Widget width in grid columns (1–6) `
5388- ` --height <value> - Widget height in grid rows (min 1) `
5489
90+ ** Examples:**
91+
92+ ``` bash
93+ # Simple counter widget
94+ sentry dashboard widget add ' My Dashboard' " Error Count" \
95+ --display big_number --query count
96+
97+ # Line chart with group-by
98+ sentry dashboard widget add ' My Dashboard' " Errors by Browser" \
99+ --display line --query count --group-by browser.name
100+
101+ # Table with multiple aggregates, sorted descending
102+ sentry dashboard widget add ' My Dashboard' " Top Endpoints" \
103+ --display table \
104+ --query count --query p95:span.duration \
105+ --group-by transaction \
106+ --sort -count --limit 10
107+
108+ # With search filter
109+ sentry dashboard widget add ' My Dashboard' " Slow Requests" \
110+ --display bar --query p95:span.duration \
111+ --where " span.op:http.client" \
112+ --group-by span.description
113+ ```
114+
55115### ` sentry dashboard widget edit <org/project/dashboard...> `
56116
57117Edit a widget in a dashboard
@@ -72,6 +132,19 @@ Edit a widget in a dashboard
72132- ` --width <value> - Widget width in grid columns (1–6) `
73133- ` --height <value> - Widget height in grid rows (min 1) `
74134
135+ ** Examples:**
136+
137+ ``` bash
138+ # Change display type
139+ sentry dashboard widget edit 12345 --title ' Error Count' --display bar
140+
141+ # Rename a widget
142+ sentry dashboard widget edit ' My Dashboard' --index 0 --new-title ' Total Errors'
143+
144+ # Change the query
145+ sentry dashboard widget edit 12345 --title ' Error Rate' --query p95:span.duration
146+ ```
147+
75148### ` sentry dashboard widget delete <org/project/dashboard...> `
76149
77150Delete a widget from a dashboard
@@ -83,4 +156,14 @@ Delete a widget from a dashboard
83156- ` -f, --force - Force the operation without confirmation `
84157- ` -n, --dry-run - Show what would happen without making changes `
85158
159+ ** Examples:**
160+
161+ ``` bash
162+ # Delete by title
163+ sentry dashboard widget delete ' My Dashboard' --title ' Error Count'
164+
165+ # Delete by index
166+ sentry dashboard widget delete 12345 --index 2
167+ ```
168+
86169All commands also support ` --json ` , ` --fields ` , ` --help ` , ` --log-level ` , and ` --verbose ` flags.
0 commit comments