@@ -112,6 +112,48 @@ sentry api /api/0/organizations/my-org/
112112sentry api /api/0/organizations/my-org/projects/ --method POST --data ' {"name":"new-project","platform":"python"}'
113113```
114114
115+ ### Dashboard Layout
116+
117+ Sentry dashboards use a ** 6-column grid** . When adding widgets, aim to fill complete rows (widths should sum to 6).
118+
119+ Default widget sizes by display type:
120+
121+ | Display Type | Width | Height | Notes |
122+ | ---| ---| ---| ---|
123+ | ` big_number ` | 2 | 1 | Compact KPI — place 3 per row (2+2+2=6) |
124+ | ` line ` | 3 | 2 | Half-width chart — place 2 per row (3+3=6) |
125+ | ` area ` | 3 | 2 | Half-width chart — place 2 per row |
126+ | ` bar ` | 3 | 2 | Half-width chart — place 2 per row |
127+ | ` table ` | 6 | 2 | Full-width — always takes its own row |
128+
129+ Common display types for general dashboards: ` big_number ` , ` line ` , ` area ` , ` bar ` , ` table ` .
130+
131+ Specialized types (only use when specifically requested): ` stacked_area ` , ` top_n ` , ` categorical_bar ` , ` text ` .
132+
133+ Internal types (avoid unless user explicitly asks): ` details ` , ` wheel ` , ` rage_and_dead_clicks ` , ` server_tree ` , ` agents_traces_table ` .
134+
135+ Available datasets: ` spans ` (default, covers most use cases), ` discover ` , ` issue ` , ` error-events ` , ` transaction-like ` , ` metrics ` , ` logs ` .
136+
137+ Run ` sentry dashboard widget types --json ` for the full machine-readable list including aggregate functions.
138+
139+ ** Row-filling examples:**
140+
141+ ``` bash
142+ # 3 KPIs filling one row (2+2+2 = 6)
143+ sentry dashboard widget add < dashboard> " Error Count" --display big_number --query count
144+ sentry dashboard widget add < dashboard> " P95 Duration" --display big_number --query p95:span.duration
145+ sentry dashboard widget add < dashboard> " Throughput" --display big_number --query epm
146+
147+ # 2 charts filling one row (3+3 = 6)
148+ sentry dashboard widget add < dashboard> " Errors Over Time" --display line --query count
149+ sentry dashboard widget add < dashboard> " Latency Over Time" --display line --query p95:span.duration
150+
151+ # Full-width table (6 = 6)
152+ sentry dashboard widget add < dashboard> " Top Endpoints" --display table \
153+ --query count --query p95:span.duration \
154+ --group-by transaction --sort -count --limit 10
155+ ```
156+
115157### Common Mistakes
116158
117159- ** Wrong issue ID format** : Use ` PROJECT-123 ` (short ID), not the numeric ID ` 123456789 ` . The short ID includes the project prefix.
@@ -229,6 +271,7 @@ Manage Sentry dashboards
229271- ` sentry dashboard widget add <args...> ` — Add a widget to a dashboard
230272- ` sentry dashboard widget edit <args...> ` — Edit a widget in a dashboard
231273- ` sentry dashboard widget delete <args...> ` — Delete a widget from a dashboard
274+ - ` sentry dashboard widget types <args...> ` — Show available widget display types and layout info
232275
233276→ Full flags and examples: ` references/dashboards.md `
234277
0 commit comments