Version 4.0.24.18 (latest)
Update all linked dashboards to match the specified LookML dashboard.
Any UDD (a dashboard which exists in the Looker database rather than as a LookML file) which has a lookml_link_id
property value referring to a LookML dashboard's id (model::dashboardname) will be updated so that it matches the current state of the LookML dashboard.
For this operation to succeed the user must have permission to view the LookML dashboard, and only linked dashboards
that the user has permission to update will be synced.
To link or unlink a UDD set the lookml_link_id
property with update_dashboard()
Request
PATCH
/dashboards/{lookml_dashboard_id}/sync
Expand HTTP Path definition...
lookml_dashboard_id
string
Id of LookML dashboard, in the form 'model::dashboardname'
Expand HTTP Body definition...
Expand Dashboard definition...
can
lock
object
Operations the current user is able to perform on this object
content_favorite_id
lock
string
Content Favorite Id
content_metadata_id
lock
string
Id of content metadata
description
string
Description
query_timezone
string
Timezone in which the Dashboard will run by default.
readonly
lock
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
lock
integer
Refresh Interval in milliseconds
title
string
Dashboard Title
user_id
lock
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
lock
string
Time that the Dashboard was created.
crossfilter_enabled
boolean
Enables crossfiltering in dashboards - only available in dashboards-next (beta)
deleted
boolean
Whether or not a dashboard is 'soft' deleted.
deleted_at
lock
string
Time that the Dashboard was 'soft' deleted.
deleter_id
lock
string
Id of User that 'soft' deleted the dashboard.
edit_uri
lock
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
lock
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
lock
string
Time the dashboard was last accessed
last_viewed_at
lock
string
Time last viewed in the Looker web UI
updated_at
lock
string
Time that the Dashboard was most recently updated.
last_updater_id
lock
string
Id of User that most recently updated the dashboard.
last_updater_name
lock
string
Name of User that most recently updated the dashboard.
user_name
lock
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
lock
integer
Number of times viewed in the Looker web UI
appearance
Dashboard visual settings only applicable to dashboards-next (beta)
url
lock
string
Relative URL of the dashboard
Expand HTTP Query definition...
raw_locale
boolean
If true, and this dashboard is localized, export it with the raw keys, not localized.
Response
200: Ids of all the dashboards that were updated by this operation
400: Bad Request
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
message
lock
string
Error details
documentation_url
lock
string
Documentation link
422: Validation Error
message
lock
string
Error details
Expand ValidationErrorDetail definition...
field
lock
string
Field with error
code
lock
string
Error code
message
lock
string
Error info message
documentation_url
lock
string
Documentation link
documentation_url
lock
string
Documentation link
429: Too Many Requests
message
lock
string
Error details
documentation_url
lock
string
Documentation link