You can also view Looker’s interactive API documentation on the Looker Developer Portal or by using the API Explorer extension.
Get All Looks beta
Implementation Notes
Get information about all active Looks.
Returns an array of abbreviated Look objects describing all the looks that the caller has access to. Soft-deleted Looks are not included.
Get the full details of a specific look by id with look(id))
Find soft-deleted looks with search_looks())
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Look beta
Implementation Notes
Create a Look.
To create a look to display query data, first create the query with create_query())
then assign the query’s id to the query_id
property in the call to create_look()
.
To place the look into a particular space, assign the space’s id to the space_id
property
in the call to create_look()
.
Response Class
LookModel {
FolderBase {
Query {
["view.field", ...]
to sort on fields in ascending order. Use the format ["view.field desc", ...]
to sort on fields in descending order. Use ["__UNSORTED__"]
(2 underscores before and after) to disable sorting entirely. Empty sorts []
will trigger a default sort.,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | Look | body |
LookWithQuery {
can (object, read-only): Operations the current user is able to perform on this object, content_metadata_id (string, read-only): Id of content metadata, id (string, read-only): Unique Id, title (string): Look Title, user_id (string): User Id, content_favorite_id (string, read-only): Content Favorite Id, created_at (date-time, read-only): Time that the Look was created., deleted (boolean): Whether or not a look is 'soft' deleted., deleted_at (date-time, read-only): Time that the Look was deleted., deleter_id (string, read-only): Id of User that deleted the look., description (string): Description, embed_url (string, read-only): Embed Url, excel_file_url (string, read-only): Excel File Url, favorite_count (long, read-only): Number of times favorited, google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula, image_embed_url (string, read-only): Image Embed Url, is_run_on_load (boolean): auto-run query when Look viewed, last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user, last_updater_id (string, read-only): Id of User that last updated the look., last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI, model (LookModel, read-only): Model, public (boolean): Is Public, public_slug (string, read-only): Public Slug, public_url (string, read-only): Public Url, query_id (string): Query Id, short_url (string, read-only): Short Url, folder (FolderBase, read-only): Folder of this Look, folder_id (string): Folder Id, updated_at (date-time, read-only): Time that the Look was updated., view_count (long, read-only): Number of times viewed in the Looker web UI, query (Query, read-only): Query, url (string, read-only): Url }LookModel { id (string, read-only): Model Id, label (string, read-only): Model Label }FolderBase { name (string, required): Unique Name, parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry, id (string, read-only): Unique Id, content_metadata_id (string, read-only): Id of content metadata, created_at (date-time, read-only): Time the folder was created, creator_id (string, read-only): User Id of Creator, child_count (long, read-only): Children Count, external_id (string, read-only): 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, read-only): Folder is an embed folder, is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder, is_embed_users_root (boolean, read-only): Folder is the root embed users folder, is_personal (boolean, read-only): Folder is a user's personal folder, is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder, is_shared_root (boolean, read-only): Folder is the root shared folder, is_users_root (boolean, read-only): Folder is the root user folder, can (object, read-only): Operations the current user is able to perform on this object }Query { can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, model (string, required): Model, view (string, required): Explore Name, fields (Array[string]): Fields, pivots (Array[string]): Pivots, fill_fields (Array[string]): Fill Fields, filters (object): Filters, filter_expression (string): Filter Expression, sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,limit (string): Limit, column_limit (string): Column Limit, total (boolean): Total, row_total (string): Raw Total, subtotals (Array[string]): Fields on which to run subtotals, 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, read-only): 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, read-only): Share Url, expanded_share_url (string, read-only): Expanded Share Url, url (string, read-only): Expanded Url, query_timezone (string): Query Timezone, has_table_calculations (boolean, read-only): Has Table Calculations }
|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Search Looks beta
Implementation Notes
Search Looks.
Returns an array of Look objects that match the specified search criteria.
If multiple search params are given and filter_or
is FALSE or not specified,
search params are combined in a logical AND operation.
Only rows that match all search param criteria will be returned.
If filter_or
is TRUE, multiple search params are combined in a logical OR operation.
Results will include rows that match any of the search criteria.
String search params use case-insensitive matching.
String search params can contain %
and ‘_’ as SQL LIKE pattern match wildcard expressions.
example=”dan%” will match “danger” and “Danzig” but not “David”
example=”D_m%” will match “Damage” and “dump”
Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values.
Most search params can accept “IS NULL” and “NOT NULL” as special expressions to match or exclude (respectively) rows where the column is null.
Boolean search params accept only “true” and “false” as values.
Get a single look by id with look(id))
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | false | Match look id. | string | string |
title | false | Match Look title. | string | string |
description | false | Match Look description. | string | string |
content_favorite_id | false | Select looks with a particular content favorite id | string | string |
folder_id | false | Select looks in a particular folder. | string | string |
user_id | false | Select looks created by a particular user. | string | string |
view_count | false | Select looks with particular view_count value | string | string |
deleted | false | Select soft-deleted looks | boolean | boolean |
query_id | false | Select looks that reference a particular query by query_id | string | string |
curate | false | Exclude items that exist only in personal spaces other than the users | boolean | boolean |
last_viewed_at | false | Select looks based on when they were last viewed | string | string |
fields | false | Requested fields. | string | string |
page | false | DEPRECATED. Use limit and offset instead. Return only page N of paginated results | integer | int64 |
per_page | false | DEPRECATED. Use limit and offset instead. Return N rows of data per page | integer | int64 |
limit | false | Number of results to return. (used with offset and takes priority over page and per_page) | integer | int64 |
offset | false | Number of results to skip before returning any. (used with limit and takes priority over page and per_page) | integer | int64 |
sorts | false | One or more fields to sort results by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :updated_at, :last_updater_id, :view_count, :favorite_count, :content_favorite_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at, :query_id] | string | string |
filter_or | false | Combine given search criteria in a boolean OR expression | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Look beta
Implementation Notes
Get a Look.
Returns detailed information about a Look and its associated Query.
Response Class
LookModel {
FolderBase {
Query {
["view.field", ...]
to sort on fields in ascending order. Use the format ["view.field desc", ...]
to sort on fields in descending order. Use ["__UNSORTED__"]
(2 underscores before and after) to disable sorting entirely. Empty sorts []
will trigger a default sort.,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Id of look | string | string |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Look beta
Implementation Notes
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.
In API 3.1 and later, 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()
.
Response Class
LookModel {
FolderBase {
Query {
["view.field", ...]
to sort on fields in ascending order. Use the format ["view.field desc", ...]
to sort on fields in descending order. Use ["__UNSORTED__"]
(2 underscores before and after) to disable sorting entirely. Empty sorts []
will trigger a default sort.,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Id of look | string | string |
body | true | Look | body |
LookWithQuery {
can (object, read-only): Operations the current user is able to perform on this object, content_metadata_id (string, read-only): Id of content metadata, id (string, read-only): Unique Id, title (string): Look Title, user_id (string): User Id, content_favorite_id (string, read-only): Content Favorite Id, created_at (date-time, read-only): Time that the Look was created., deleted (boolean): Whether or not a look is 'soft' deleted., deleted_at (date-time, read-only): Time that the Look was deleted., deleter_id (string, read-only): Id of User that deleted the look., description (string): Description, embed_url (string, read-only): Embed Url, excel_file_url (string, read-only): Excel File Url, favorite_count (long, read-only): Number of times favorited, google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula, image_embed_url (string, read-only): Image Embed Url, is_run_on_load (boolean): auto-run query when Look viewed, last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user, last_updater_id (string, read-only): Id of User that last updated the look., last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI, model (LookModel, read-only): Model, public (boolean): Is Public, public_slug (string, read-only): Public Slug, public_url (string, read-only): Public Url, query_id (string): Query Id, short_url (string, read-only): Short Url, folder (FolderBase, read-only): Folder of this Look, folder_id (string): Folder Id, updated_at (date-time, read-only): Time that the Look was updated., view_count (long, read-only): Number of times viewed in the Looker web UI, query (Query, read-only): Query, url (string, read-only): Url }LookModel { id (string, read-only): Model Id, label (string, read-only): Model Label }FolderBase { name (string, required): Unique Name, parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry, id (string, read-only): Unique Id, content_metadata_id (string, read-only): Id of content metadata, created_at (date-time, read-only): Time the folder was created, creator_id (string, read-only): User Id of Creator, child_count (long, read-only): Children Count, external_id (string, read-only): 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, read-only): Folder is an embed folder, is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder, is_embed_users_root (boolean, read-only): Folder is the root embed users folder, is_personal (boolean, read-only): Folder is a user's personal folder, is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder, is_shared_root (boolean, read-only): Folder is the root shared folder, is_users_root (boolean, read-only): Folder is the root user folder, can (object, read-only): Operations the current user is able to perform on this object }Query { can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, model (string, required): Model, view (string, required): Explore Name, fields (Array[string]): Fields, pivots (Array[string]): Pivots, fill_fields (Array[string]): Fill Fields, filters (object): Filters, filter_expression (string): Filter Expression, sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,limit (string): Limit, column_limit (string): Column Limit, total (boolean): Total, row_total (string): Raw Total, subtotals (Array[string]): Fields on which to run subtotals, 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, read-only): 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, read-only): Share Url, expanded_share_url (string, read-only): Expanded Share Url, url (string, read-only): Expanded Url, query_timezone (string): Query Timezone, has_table_calculations (boolean, read-only): Has Table Calculations }
|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Look beta
Implementation Notes
Permanently Delete a Look.
This operation permanently removes a look from the Looker database.
NOTE: There is no “undo” for this kind of delete.
For information about soft-delete (which can be undone) see update_look()).
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Id of look | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Run Look
Implementation Notes
Run a Look.
Runs a given look’s query and returns the results in the requested format.
Supported formats:
result_format | Description |
---|---|
json | Plain json |
json_detail | Row data plus metadata describing the fields, pivots, table calcs, and other aspects of the query |
csv | Comma separated values with a header |
txt | Tab separated values with a header |
html | Simple html |
md | Simple markdown |
xlsx | MS Excel spreadsheet |
sql | Returns the generated SQL rather than running the query |
png | A PNG image of the visualization of the query |
jpg | A JPG image of the visualization of the query |
Response Class
string
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Id of look | string | string |
result_format | true | Format of result | string | string |
limit | false | Row limit (may override the limit in the saved query). | integer | int64 |
apply_formatting | false | Apply model-specified formatting to each result. | boolean | boolean |
apply_vis | false | Apply visualization options to results. | boolean | boolean |
cache | false | Get results from cache if available. | boolean | boolean |
image_width | false | Render width for image formats. | integer | int64 |
image_height | false | Render height for image formats. | integer | int64 |
generate_drill_links | false | Generate drill links (only applicable to ‘json_detail’ format. | boolean | boolean |
force_production | false | Force use of production models even if the user is in development mode. | boolean | boolean |
cache_only | false | Retrieve any results from cache even if the results have expired. | boolean | boolean |
path_prefix | false | Prefix to use for drill links (url encoded). | string | string |
rebuild_pdts | false | Rebuild PDTS used in query. | boolean | boolean |
server_table_calcs | false | Perform table calculations on query results | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Copy Look beta
Implementation Notes
Copy an existing look.
Creates a copy of an existing look, in a specified folder, and returns the copied look.
look_id
and folder_id
are required.
look_id
and folder_id
must already exist, and folder_id
must be different from the current folder_id
of the dashboard.
Response Class
LookModel {
FolderBase {
Query {
["view.field", ...]
to sort on fields in ascending order. Use the format ["view.field desc", ...]
to sort on fields in descending order. Use ["__UNSORTED__"]
(2 underscores before and after) to disable sorting entirely. Empty sorts []
will trigger a default sort.,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Look id to copy. | string | string |
folder_id | false | Folder id to copy to. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
201 | look |
Look {
can (object, read-only): Operations the current user is able to perform on this object, content_metadata_id (string, read-only): Id of content metadata, id (string, read-only): Unique Id, title (string): Look Title, user_id (string): User Id, content_favorite_id (string, read-only): Content Favorite Id, created_at (date-time, read-only): Time that the Look was created., deleted (boolean): Whether or not a look is 'soft' deleted., deleted_at (date-time, read-only): Time that the Look was deleted., deleter_id (string, read-only): Id of User that deleted the look., description (string): Description, embed_url (string, read-only): Embed Url, excel_file_url (string, read-only): Excel File Url, favorite_count (long, read-only): Number of times favorited, google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula, image_embed_url (string, read-only): Image Embed Url, is_run_on_load (boolean): auto-run query when Look viewed, last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user, last_updater_id (string, read-only): Id of User that last updated the look., last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI, model (LookModel, read-only): Model, public (boolean): Is Public, public_slug (string, read-only): Public Slug, public_url (string, read-only): Public Url, query_id (string): Query Id, short_url (string, read-only): Short Url, folder (FolderBase, read-only): Folder of this Look, folder_id (string): Folder Id, updated_at (date-time, read-only): Time that the Look was updated., view_count (long, read-only): Number of times viewed in the Looker web UI }LookModel { id (string, read-only): Model Id, label (string, read-only): Model Label }FolderBase { name (string, required): Unique Name, parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry, id (string, read-only): Unique Id, content_metadata_id (string, read-only): Id of content metadata, created_at (date-time, read-only): Time the folder was created, creator_id (string, read-only): User Id of Creator, child_count (long, read-only): Children Count, external_id (string, read-only): 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, read-only): Folder is an embed folder, is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder, is_embed_users_root (boolean, read-only): Folder is the root embed users folder, is_personal (boolean, read-only): Folder is a user's personal folder, is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder, is_shared_root (boolean, read-only): Folder is the root shared folder, is_users_root (boolean, read-only): Folder is the root user folder, can (object, read-only): Operations the current user is able to perform on this object }
|
Move Look beta
Implementation Notes
Move an existing look.
Moves a look to a specified folder, and returns the moved look.
look_id
and folder_id
are required.
look_id
and folder_id
must already exist, and folder_id
must be different from the current folder_id
of the dashboard.
Response Class
LookModel {
FolderBase {
Query {
["view.field", ...]
to sort on fields in ascending order. Use the format ["view.field desc", ...]
to sort on fields in descending order. Use ["__UNSORTED__"]
(2 underscores before and after) to disable sorting entirely. Empty sorts []
will trigger a default sort.,Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
look_id | true | Look id to move. | string | string |
folder_id | true | Folder id to move to. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
201 | look |
Look {
can (object, read-only): Operations the current user is able to perform on this object, content_metadata_id (string, read-only): Id of content metadata, id (string, read-only): Unique Id, title (string): Look Title, user_id (string): User Id, content_favorite_id (string, read-only): Content Favorite Id, created_at (date-time, read-only): Time that the Look was created., deleted (boolean): Whether or not a look is 'soft' deleted., deleted_at (date-time, read-only): Time that the Look was deleted., deleter_id (string, read-only): Id of User that deleted the look., description (string): Description, embed_url (string, read-only): Embed Url, excel_file_url (string, read-only): Excel File Url, favorite_count (long, read-only): Number of times favorited, google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula, image_embed_url (string, read-only): Image Embed Url, is_run_on_load (boolean): auto-run query when Look viewed, last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user, last_updater_id (string, read-only): Id of User that last updated the look., last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI, model (LookModel, read-only): Model, public (boolean): Is Public, public_slug (string, read-only): Public Slug, public_url (string, read-only): Public Url, query_id (string): Query Id, short_url (string, read-only): Short Url, folder (FolderBase, read-only): Folder of this Look, folder_id (string): Folder Id, updated_at (date-time, read-only): Time that the Look was updated., view_count (long, read-only): Number of times viewed in the Looker web UI }LookModel { id (string, read-only): Model Id, label (string, read-only): Model Label }FolderBase { name (string, required): Unique Name, parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry, id (string, read-only): Unique Id, content_metadata_id (string, read-only): Id of content metadata, created_at (date-time, read-only): Time the folder was created, creator_id (string, read-only): User Id of Creator, child_count (long, read-only): Children Count, external_id (string, read-only): 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, read-only): Folder is an embed folder, is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder, is_embed_users_root (boolean, read-only): Folder is the root embed users folder, is_personal (boolean, read-only): Folder is a user's personal folder, is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder, is_shared_root (boolean, read-only): Folder is the root shared folder, is_users_root (boolean, read-only): Folder is the root user folder, can (object, read-only): Operations the current user is able to perform on this object }
|