User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Look : Run and Manage Looks

Get All Looks beta

GET/api/3.0/looks
all_looks(fields)

Implementation Notes

Get all the 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

POST/api/3.0/looks
create_look(body, fields)

Implementation Notes

Create a Look with specified information.

Response Class

LookWithQuery {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
view_count (long, read-only): Number of times viewed in the Looker web UI,
favorite_count (long, read-only): Number of times favorited,
content_favorite_id (long, read-only): Content Favorite Id,
title (string): Look Title,
user (UserIdOnly, read-only): User,
query_id (long): Query Id,
description (string): Description,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
public (boolean, read-only): Is Public,
public_slug (string, read-only): Public Slug,
user_id (long): (Write-Only) User Id,
space_id (string): (Write-Only) Space Id,
model (LookModel, read-only): Model,
public_url (string, read-only): Public Url,
embed_url (string, read-only): Embed Url,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
excel_file_url (string, read-only): Excel File Url,
url (string, read-only): Url,
query (Query, read-only): Query,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
last_updater_id (long, 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,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
deleter_id (long, read-only): Id of User that deleted the look.,
deleted (boolean): Whether or not the look is deleted,
is_run_on_load (boolean): auto-run query when Look viewed,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
Query {
id (long, 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,
runtime (double): Runtime,
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 (Array[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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Look body
LookWithQuery {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
view_count (long, read-only): Number of times viewed in the Looker web UI,
favorite_count (long, read-only): Number of times favorited,
content_favorite_id (long, read-only): Content Favorite Id,
title (string): Look Title,
user (UserIdOnly, read-only): User,
query_id (long): Query Id,
description (string): Description,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
public (boolean, read-only): Is Public,
public_slug (string, read-only): Public Slug,
user_id (long): (Write-Only) User Id,
space_id (string): (Write-Only) Space Id,
model (LookModel, read-only): Model,
public_url (string, read-only): Public Url,
embed_url (string, read-only): Embed Url,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
excel_file_url (string, read-only): Excel File Url,
url (string, read-only): Url,
query (Query, read-only): Query,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
last_updater_id (long, 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,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
deleter_id (long, read-only): Id of User that deleted the look.,
deleted (boolean): Whether or not the look is deleted,
is_run_on_load (boolean): auto-run query when Look viewed,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
Query {
id (long, 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,
runtime (double): Runtime,
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 (Array[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,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Search Looks beta

GET/api/3.0/looks/search
search_looks(fields, page, per_page, limit, offset, sorts, title, description, content_favorite_id, space_id, user_id, view_count)

Implementation Notes

Search looks.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
fields false Requested fields. string string
page false Requested page. integer int64
per_page false Results 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 Fields to sort by. string string
title false Match Look title. string string
description false Match Look description. string string
content_favorite_id false Match content favorite id integer int64
space_id false Filter on a particular space. string string
user_id false Filter on dashboards created by a particular user. string string
view_count false Filter on a particular value of view_count 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
}

Get Look beta

GET/api/3.0/looks/{look_id}
look(look_id, fields)

Implementation Notes

Get a Look.

Returns detailed information about a Look and its associated Query.

Response Class

LookWithQuery {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
view_count (long, read-only): Number of times viewed in the Looker web UI,
favorite_count (long, read-only): Number of times favorited,
content_favorite_id (long, read-only): Content Favorite Id,
title (string): Look Title,
user (UserIdOnly, read-only): User,
query_id (long): Query Id,
description (string): Description,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
public (boolean, read-only): Is Public,
public_slug (string, read-only): Public Slug,
user_id (long): (Write-Only) User Id,
space_id (string): (Write-Only) Space Id,
model (LookModel, read-only): Model,
public_url (string, read-only): Public Url,
embed_url (string, read-only): Embed Url,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
excel_file_url (string, read-only): Excel File Url,
url (string, read-only): Url,
query (Query, read-only): Query,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
last_updater_id (long, 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,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
deleter_id (long, read-only): Id of User that deleted the look.,
deleted (boolean): Whether or not the look is deleted,
is_run_on_load (boolean): auto-run query when Look viewed,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
Query {
id (long, 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,
runtime (double): Runtime,
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 (Array[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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
look_id true Id of look integer int64
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

PATCH/api/3.0/looks/{look_id}
update_look(look_id, body, fields)

Implementation Notes

Update the Look with a specific id.

Response Class

LookWithQuery {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
view_count (long, read-only): Number of times viewed in the Looker web UI,
favorite_count (long, read-only): Number of times favorited,
content_favorite_id (long, read-only): Content Favorite Id,
title (string): Look Title,
user (UserIdOnly, read-only): User,
query_id (long): Query Id,
description (string): Description,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
public (boolean, read-only): Is Public,
public_slug (string, read-only): Public Slug,
user_id (long): (Write-Only) User Id,
space_id (string): (Write-Only) Space Id,
model (LookModel, read-only): Model,
public_url (string, read-only): Public Url,
embed_url (string, read-only): Embed Url,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
excel_file_url (string, read-only): Excel File Url,
url (string, read-only): Url,
query (Query, read-only): Query,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
last_updater_id (long, 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,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
deleter_id (long, read-only): Id of User that deleted the look.,
deleted (boolean): Whether or not the look is deleted,
is_run_on_load (boolean): auto-run query when Look viewed,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
Query {
id (long, 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,
runtime (double): Runtime,
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 (Array[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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
look_id true Id of look integer int64
body true Look body
LookWithQuery {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
view_count (long, read-only): Number of times viewed in the Looker web UI,
favorite_count (long, read-only): Number of times favorited,
content_favorite_id (long, read-only): Content Favorite Id,
title (string): Look Title,
user (UserIdOnly, read-only): User,
query_id (long): Query Id,
description (string): Description,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
public (boolean, read-only): Is Public,
public_slug (string, read-only): Public Slug,
user_id (long): (Write-Only) User Id,
space_id (string): (Write-Only) Space Id,
model (LookModel, read-only): Model,
public_url (string, read-only): Public Url,
embed_url (string, read-only): Embed Url,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
excel_file_url (string, read-only): Excel File Url,
url (string, read-only): Url,
query (Query, read-only): Query,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
last_updater_id (long, 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,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
deleter_id (long, read-only): Id of User that deleted the look.,
deleted (boolean): Whether or not the look is deleted,
is_run_on_load (boolean): auto-run query when Look viewed,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
Query {
id (long, 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,
runtime (double): Runtime,
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 (Array[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,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Delete Look beta

DELETE/api/3.0/looks/{look_id}
delete_look(look_id)

Implementation Notes

Delete the look with a specific id.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
look_id true Id of look integer int64

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
}
204 Successfully deleted. string

Run Look

GET/api/3.0/looks/{look_id}/run/{result_format}
run_look(look_id, result_format, limit, apply_formatting, apply_vis, cache, image_width, image_height, generate_drill_links, force_production, cache_only, path_prefix, rebuild_pdts, server_table_calcs)

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 integer int64
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
}
Top