Version 4.0.25.2 (latest)
Get the default theme
Returns the active theme object set as the default.
The default theme name can be set in the UI on the Admin|Theme UI page
The optional ts
parameter can specify a different timestamp than "now." If specified, it returns the default theme at the time indicated.
Request
GET
/themes/default
Datatype
Description
Request
query
Expand HTTP Query definition...
ts
Timestamp representing the target datetime for the active period. Defaults to 'now'
Response
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
begin_at
Timestamp for when this theme becomes active. Null=always
end_at
Timestamp for when this theme expires. Null=never
id
lock
Unique Id
name
Name of theme. Can only be alphanumeric and underscores.
settings
Hash of name/value pairs for theme settings. These names get validated.
Expand ThemeSettings definition...
background_color
Default background color
base_font_size
Base font size for scaling fonts (only supported by legacy dashboards)
color_collection_id
Optional. ID of color collection to use with the theme. Use an empty string for none.
font_color
Default font color
font_family
Primary font family
font_source
Source specification for font
info_button_color
(DEPRECATED) Info button color
primary_button_color
Primary button color
show_filters_bar
Toggle to show filters. Defaults to true.
show_title
Toggle to show the title. Defaults to true.
text_tile_text_color
Text color for text tiles
tile_background_color
Background color for tiles
text_tile_background_color
Background color for text tiles
tile_text_color
Text color for tiles
title_color
Color for titles
warn_button_color
(DEPRECATED) Warning button color
tile_title_alignment
The text alignment of tile titles (New Dashboards)
tile_shadow
Toggles the tile shadow (not supported)
show_last_updated_indicator
Toggle to show the dashboard last updated indicator. Defaults to true.
show_reload_data_icon
Toggle to show reload data icon/button. Defaults to true.
show_dashboard_menu
Toggle to show the dashboard actions menu. Defaults to true.
show_filters_toggle
Toggle to show the filters icon/toggle. Defaults to true.
show_dashboard_header
Toggle to show the dashboard header. Defaults to true.
center_dashboard_title
Toggle to center the dashboard title. Defaults to false.
dashboard_title_font_size
Dashboard title font size.
box_shadow
Default box shadow.
page_margin_top
Dashboard page margin top.
page_margin_bottom
Dashboard page margin bottom.
page_margin_sides
Dashboard page margin left and right.
show_explore_header
Toggle to show the explore page header. Defaults to true.
show_explore_title
Toggle to show the explore page title. Defaults to true.
show_explore_last_run
Toggle to show the explore page last run. Defaults to true.
show_explore_timezone
Toggle to show the explore page timezone. Defaults to true.
show_explore_run_stop_button
Toggle to show the explore page run button. Defaults to true.
show_explore_actions_button
Toggle to show the explore page actions button. Defaults to true.
show_look_header
Toggle to show the look page header. Defaults to true.
show_look_title
Toggle to show the look page title. Defaults to true.
show_look_last_run
Toggle to show the look page last run. Defaults to true.
show_look_timezone
Toggle to show the look page timezone Defaults to true.
show_look_run_stop_button
Toggle to show the look page run button. Defaults to true.
show_look_actions_button
Toggle to show the look page actions button. Defaults to true.
tile_title_font_size
Font size for tiles.
column_gap_size
The vertical gap/gutter size between tiles.
row_gap_size
The horizontal gap/gutter size between tiles.
border_radius
The border radius for tiles.
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link