Version 4.0.24.12
Modify a Look
Use this function to modify parts of a look. Property values given in a call to update_look
are
applied to the existing look, so there's no need to include properties whose values are not changing.
It's best to specify only the properties you want to change and leave everything else out
of your update_look
call. Look properties marked 'read-only' will be ignored.
When a user deletes a look in the Looker UI, the look data remains in the database but is
marked with a deleted flag ("soft-deleted"). Soft-deleted looks can be undeleted (by an admin)
if the delete was in error.
To soft-delete a look via the API, use update_look() to change the look's deleted
property to true
.
You can undelete a look by calling update_look
to change the look's deleted
property to false
.
Soft-deleted looks are excluded from the results of all_looks() and search_looks(), so they
essentially disappear from view even though they still reside in the db.
You can pass deleted: true
as a parameter to search_looks() to list soft-deleted looks.
NOTE: delete_look() performs a "hard delete" - the look data is removed from the Looker
database and destroyed. There is no "undo" for delete_look()
.
Request
PATCH
/looks/{look_id}
Expand HTTP Path definition...
look_id
string
Id of look
Expand HTTP Body definition...
Expand LookWithQuery definition...
can
lock
object
Operations the current user is able to perform on this object
content_metadata_id
lock
string
Id of content metadata
content_favorite_id
lock
string
Content Favorite Id
created_at
lock
string
Time that the Look was created.
deleted
boolean
Whether or not a look is 'soft' deleted.
deleted_at
lock
string
Time that the Look was deleted.
deleter_id
lock
string
Id of User that deleted the look.
description
string
Description
embed_url
lock
string
Embed Url
excel_file_url
lock
string
Excel File Url
favorite_count
lock
integer
Number of times favorited
google_spreadsheet_formula
lock
string
Google Spreadsheet Formula
image_embed_url
lock
string
Image Embed Url
is_run_on_load
boolean
auto-run query when Look viewed
last_accessed_at
lock
string
Time that the Look was last accessed by any user
last_updater_id
lock
string
Id of User that last updated the look.
last_viewed_at
lock
string
Time last viewed in the Looker web UI
public_slug
lock
string
Public Slug
public_url
lock
string
Public Url
short_url
lock
string
Short Url
folder
lock
Folder of this Look
folder_id
string
Folder Id
updated_at
lock
string
Time that the Look was updated.
view_count
lock
integer
Number of times viewed in the Looker web UI
Expand HTTP Query definition...
fields
string
Requested fields.
Response
200: Look
can
lock
object
Operations the current user is able to perform on this object
content_metadata_id
lock
string
Id of content metadata
content_favorite_id
lock
string
Content Favorite Id
created_at
lock
string
Time that the Look was created.
deleted
boolean
Whether or not a look is 'soft' deleted.
deleted_at
lock
string
Time that the Look was deleted.
deleter_id
lock
string
Id of User that deleted the look.
description
string
Description
embed_url
lock
string
Embed Url
excel_file_url
lock
string
Excel File Url
favorite_count
lock
integer
Number of times favorited
google_spreadsheet_formula
lock
string
Google Spreadsheet Formula
image_embed_url
lock
string
Image Embed Url
is_run_on_load
boolean
auto-run query when Look viewed
last_accessed_at
lock
string
Time that the Look was last accessed by any user
last_updater_id
lock
string
Id of User that last updated the look.
last_viewed_at
lock
string
Time last viewed in the Looker web UI
Expand LookModel definition...
label
lock
string
Model Label
public_slug
lock
string
Public Slug
public_url
lock
string
Public Url
short_url
lock
string
Short Url
folder
lock
Folder of this Look
Expand FolderBase definition...
parent_id
string
Id of Parent. If the parent id is null, this is a root-level entry
content_metadata_id
lock
string
Id of content metadata
created_at
lock
string
Time the folder was created
creator_id
lock
string
User Id of Creator
child_count
lock
integer
Children Count
external_id
lock
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
lock
boolean
Folder is an embed folder
is_embed_shared_root
lock
boolean
Folder is the root embed shared folder
is_embed_users_root
lock
boolean
Folder is the root embed users folder
is_personal
lock
boolean
Folder is a user's personal folder
is_personal_descendant
lock
boolean
Folder is descendant of a user's personal folder
is_shared_root
lock
boolean
Folder is the root shared folder
is_users_root
lock
boolean
Folder is the root user folder
can
lock
object
Operations the current user is able to perform on this object
folder_id
string
Folder Id
updated_at
lock
string
Time that the Look was updated.
view_count
lock
integer
Number of times viewed in the Looker web UI
Expand Query definition...
can
lock
object
Operations the current user is able to perform on this object
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
column_limit
string
Column Limit
row_total
string
Raw Total
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
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
lock
string
Share Url
expanded_share_url
lock
string
Expanded Share Url
url
lock
string
Expanded Url
query_timezone
string
Query Timezone
has_table_calculations
lock
boolean
Has Table Calculations
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
Examples