Import Dashboard from LookML

Version 4.0.24.18 (latest)

Creates a dashboard object based on LookML Dashboard YAML, and returns the details of the newly created dashboard.

If a dashboard exists with the YAML-defined "preferred_slug", the new dashboard will overwrite it. Otherwise, a new dashboard will be created. Note that when a dashboard is overwritten, alerts will not be maintained.

If a folder_id is specified: new dashboards will be placed in that folder, and overwritten dashboards will be moved to it If the folder_id isn't specified: new dashboards will be placed in the caller's personal folder, and overwritten dashboards will remain where they were

LookML must contain valid LookML YAML code. It's recommended to use the LookML format returned from dashboard_lookml() as the input LookML (newlines replaced with ).

Note that the created dashboard is not linked to any LookML Dashboard, i.e. sync_lookml_dashboard() will not update dashboards created by this method.

Request

POST /dashboards/lookml
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
DashboardLookML
Expand DashboardLookml definition...
dashboard_id
string
Id of Dashboard
folder_id
string
(Write-Only) Id of the folder
lookml
string
lookml of UDD

Response

200: dashboard

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
content_favorite_id
string
Content Favorite Id
content_metadata_id
string
Id of content metadata
description
string
Description
hidden
boolean
Is Hidden
id
string
Unique Id
model
Model
Expand LookModel definition...
id
string
Model Id
label
string
Model Label
query_timezone
string
Timezone in which the Dashboard will run by default.
readonly
boolean
Is Read-only
refresh_interval
string
Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.
refresh_interval_to_i
integer
Refresh Interval in milliseconds
folder
Folder
Expand FolderBase definition...
name
string
Unique Name
parent_id
string
Id of Parent. If the parent id is null, this is a root-level entry
id
string
Unique Id
content_metadata_id
string
Id of content metadata
created_at
string
Time the folder was created
creator_id
string
User Id of Creator
child_count
integer
Children Count
external_id
string
Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login
is_embed
boolean
Folder is an embed folder
is_embed_shared_root
boolean
Folder is the root embed shared folder
is_embed_users_root
boolean
Folder is the root embed users folder
is_personal
boolean
Folder is a user's personal folder
is_personal_descendant
boolean
Folder is descendant of a user's personal folder
is_shared_root
boolean
Folder is the root shared folder
is_users_root
boolean
Folder is the root user folder
can
object
Operations the current user is able to perform on this object
title
string
Dashboard Title
user_id
string
Id of User
slug
string
Content Metadata Slug
preferred_viewer
string
The preferred route for viewing this dashboard (ie: dashboards or dashboards-next)
alert_sync_with_dashboard_filter_enabled
boolean
Enables alerts to keep in sync with dashboard filter changes
background_color
string
Background color
created_at
string
Time that the Dashboard was created.
crossfilter_enabled
boolean
Enables crossfiltering in dashboards - only available in dashboards-next (beta)
dashboard_elements
Expand DashboardElement definition...
can
object
Operations the current user is able to perform on this object
body_text
string
Text tile body text
body_text_as_html
string
Text tile body text as Html
dashboard_id
string
Id of Dashboard
edit_uri
string
Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).
id
string
Unique Id
look
Look
Expand LookWithQuery definition...
can
object
Operations the current user is able to perform on this object
content_metadata_id
string
Id of content metadata
id
string
Unique Id
title
string
Look Title
user_id
string
User Id
content_favorite_id
string
Content Favorite Id
created_at
string
Time that the Look was created.
deleted
boolean
Whether or not a look is 'soft' deleted.
deleted_at
string
Time that the Look was deleted.
deleter_id
string
Id of User that deleted the look.
description
string
Description
embed_url
string
Embed Url
excel_file_url
string
Excel File Url
favorite_count
integer
Number of times favorited
google_spreadsheet_formula
string
Google Spreadsheet Formula
image_embed_url
string
Image Embed Url
is_run_on_load
boolean
auto-run query when Look viewed
last_accessed_at
string
Time that the Look was last accessed by any user
last_updater_id
string
Id of User that last updated the look.
last_viewed_at
string
Time last viewed in the Looker web UI
model
Model
public
boolean
Is Public
public_slug
string
Public Slug
public_url
string
Public Url
query_id
string
Query Id
short_url
string
Short Url
folder
Folder of this Look
folder_id
string
Folder Id
updated_at
string
Time that the Look was updated.
user_name
string
Name of User that created the look.
view_count
integer
Number of times viewed in the Looker web UI
query
Query
url
string
Url
look_id
string
Id Of Look
lookml_link_id
string
LookML link ID
merge_result_id
string
ID of merge result
note_display
string
Note Display
note_state
string
Note State
note_text
string
Note Text
note_text_as_html
string
Note Text as Html
query
Query
Expand Query definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
model
string
Model
view
string
Explore Name
fields
string[]
pivots
string[]
fill_fields
string[]
filters
object
Filters will contain data pertaining to complex filters that do not contain "or" conditions. When "or" conditions are present, filter data will be found on the `filter_expression` property.
filter_expression
string
Filter Expression
sorts
string[]
limit
string
Limit
column_limit
string
Column Limit
total
boolean
Total
row_total
string
Raw Total
subtotals
string[]
vis_config
object
Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
filter_config
object
The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.
visible_ui_sections
string
Visible UI Sections
slug
string
Slug
dynamic_fields
string
Dynamic Fields
client_id
string
Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.
share_url
string
Share Url
expanded_share_url
string
Expanded Share Url
url
string
Expanded Url
query_timezone
string
Query Timezone
has_table_calculations
boolean
Has Table Calculations
query_id
string
Id Of Query
refresh_interval
string
Refresh Interval
refresh_interval_to_i
integer
Refresh Interval as integer
result_maker
Data about the result maker.
Expand ResultMakerWithIdVisConfigAndDynamicFields definition...
id
string
Unique Id.
dynamic_fields
string
JSON string of dynamic field information.
filterables
sorts
string[]
merge_result_id
string
ID of merge result if this is a merge_result.
total
boolean
Total of the constituent Look, Query, or Merge Query
query_id
string
ID of query if this is a query.
sql_query_id
string
ID of SQL Query if this is a SQL Runner Query
query
Query
vis_config
object
Vis config of the constituent Query, or Merge Query.
result_maker_id
string
ID of the ResultMakerLookup entry.
subtitle_text
string
Text tile subtitle text
title
string
Title of dashboard element
title_hidden
boolean
Whether title is hidden
title_text
string
Text tile title
type
string
Type
alert_count
integer
Count of Alerts associated to a dashboard element
rich_content_json
string
JSON with all the properties required for rich editor and buttons elements
title_text_as_html
string
Text tile title text as Html
subtitle_text_as_html
string
Text tile subtitle text as Html
extension_id
string
Extension ID
dashboard_filters
Expand DashboardFilter definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
dashboard_id
string
Id of Dashboard
name
string
Name of filter
title
string
Title of filter
type
string
Type of filter: one of date, number, string, or field
default_value
string
Default value of filter
model
string
Model of filter (required if type = field)
explore
string
Explore of filter (required if type = field)
dimension
string
Dimension of filter (required if type = field)
field
object
Field information
row
integer
Display order of this filter relative to other filters
listens_to_filters
string[]
allow_multiple_values
boolean
Whether the filter allows multiple filter values (deprecated in the latest version of dashboards)
required
boolean
Whether the filter requires a value to run the dashboard
ui_config
object
The visual configuration for this filter. Used to set up how the UI for this filter should appear.
dashboard_layouts
Expand DashboardLayout definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
dashboard_id
string
Id of Dashboard
type
string
Type
active
boolean
Is Active
column_width
integer
Column Width
width
integer
Width
deleted
boolean
Whether or not the dashboard layout is deleted.
dashboard_title
string
Title extracted from the dashboard this layout represents.
dashboard_layout_components
Expand DashboardLayoutComponent definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
dashboard_layout_id
string
Id of Dashboard Layout
dashboard_element_id
string
Id Of Dashboard Element
row
integer
Row
column
integer
Column
width
integer
Width
height
integer
Height
deleted
boolean
Whether or not the dashboard layout component is deleted
element_title
string
Dashboard element title, extracted from the Dashboard Element.
element_title_hidden
boolean
Whether or not the dashboard element title is displayed.
vis_type
string
Visualization type, extracted from a query's vis_config
deleted
boolean
Whether or not a dashboard is 'soft' deleted.
deleted_at
string
Time that the Dashboard was 'soft' deleted.
deleter_id
string
Id of User that 'soft' deleted the dashboard.
edit_uri
string
Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).
enable_viz_full_screen
boolean
Allow visualizations to be viewed in full screen mode
favorite_count
integer
Number of times favorited
filters_bar_collapsed
boolean
Sets the default state of the filters bar to collapsed or open
filters_location_top
boolean
Sets the default state of the filters location to top(true) or right(false)
last_accessed_at
string
Time the dashboard was last accessed
last_viewed_at
string
Time last viewed in the Looker web UI
updated_at
string
Time that the Dashboard was most recently updated.
last_updater_id
string
Id of User that most recently updated the dashboard.
last_updater_name
string
Name of User that most recently updated the dashboard.
user_name
string
Name of User that created the dashboard.
load_configuration
string
configuration option that governs how dashboard loading will happen.
lookml_link_id
string
Links this dashboard to a particular LookML dashboard such that calling a **sync** operation on that LookML dashboard will update this dashboard to match.
show_filters_bar
boolean
Show filters bar. **Security Note:** This property only affects the *cosmetic* appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does **NOT** prevent users from changing filters by other means. For information on how to set up secure data access control policies, see [Control User Access to Data](https://cloud.google.com/looker/docs/r/api/control-access)
show_title
boolean
Show title
folder_id
string
Id of folder
text_tile_text_color
string
Color of text on text tiles
tile_background_color
string
Tile background color
tile_text_color
string
Tile text color
title_color
string
Title color
view_count
integer
Number of times viewed in the Looker web UI
appearance
Dashboard visual settings only applicable to dashboards-next (beta)
Expand DashboardAppearance definition...
page_side_margins
integer
Page margin (side) width
page_background_color
string
Background color for the dashboard
tile_title_alignment
string
Title alignment on dashboard tiles
tile_space_between
integer
Space between tiles
tile_background_color
string
Background color for tiles
tile_shadow
boolean
Tile shadow on/off
key_color
string
Key color
url
string
Relative URL of the dashboard

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

409: Resource Already Exists

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link