created_atstring date-time required
last_accessed_atstring date-time nullable required
last_viewed_atstring date-time nullable required
folderstring nullable required
Path of the project-tree folder this dashboard is filed under in the file system, e.g. 'Unfiled/Dashboards'. An empty string means the project root; null means the dashboard has no file system entry. The dashboard's own name is not part of the path.
file_system_idstring uuid nullable required
Id of this dashboard's file system entry, or null when it has none. Together with file_system_path this is everything a caller needs to move the dashboard between folders, so a list page does not have to look the entry up separately.
file_system_pathstring nullable required
Full path of this dashboard's file system entry, e.g. 'Unfiled/Dashboards/Revenue'. Unlike folder this keeps the dashboard's own name as the last segment, which is what a move needs in order to compute the destination path. Null when it has no entry.
is_sharedboolean required
creation_mode'default' | 'template' | 'duplicate' | 'unlisted' required
- default - Default
- template - Template
- duplicate - Duplicate
- unlisted - Unlisted (product-embedded)
variablesobject nullable required
data_color_theme_idinteger nullable
ID of the color theme used for chart visualizations.
restriction_level21 | 37
- 21 - Everyone in the project can edit
- 37 - Only those invited to this dashboard can edit
effective_restriction_level21 | 37 required
- 21 - Everyone in the project can edit
- 37 - Only those invited to this dashboard can edit
effective_privilege_level21 | 37 required
- 21 - Can view dashboard
- 37 - Can edit dashboard
user_access_levelstring nullable required
The effective access level the user has for this object
access_control_versionstring required
last_refreshstring date-time nullable
persisted_filtersobject nullable required
persisted_variablesobject nullable required
quick_filter_idsstring[] nullable
List of quick filter IDs associated with this dashboard
grid_spacing'tight' | 'condensed' | 'standard' | 'relaxed' | 'wide'
- tight - tight
- condensed - condensed
- standard - standard
- relaxed - relaxed
- wide - wide
layout_compaction'vertical' | 'horizontal' | 'stable'
- vertical - vertical
- horizontal - horizontal
- stable - stable
group_titlesobject nullable
Titles for tile groups, keyed by the tiles' group_key. The dashboard shows a title above its group. A write replaces the whole map. Send an empty object or null to remove all group titles.
tilesobject[] nullable required
use_templatestring
Template key to create the dashboard from a predefined template.
use_dashboardinteger nullable
ID of an existing dashboard to duplicate.
delete_insightsboolean
When deleting, also delete insights that are only on this dashboard.