User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Space : Manage Spaces

Search Spaces beta

GET/api/3.1/spaces/search
search_spaces(fields, page, per_page, limit, offset, sorts, name, id, parent_id, creator_id, filter_or)

Implementation Notes

Search Spaces.

Returns an array of space objects that match the given 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.

The parameters limit, and offset are recommended for fetching results in page-size chunks.

Get a single space by id with Space)

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
name false Match Space title. string string
id false Match Space id integer int64
parent_id false Filter on a children of a particular space. string string
creator_id false Filter on spaces created by a particular user. 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 Space beta

GET/api/3.1/spaces/{space_id}
space(space_id, fields)

Implementation Notes

Get information about the space with a specific id.

Response Class

Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}

Delete Space beta

DELETE/api/3.1/spaces/{space_id}
delete_space(space_id)

Implementation Notes

Delete the space with a specific id including any children spaces.

DANGER this will delete all looks and dashboards in the space.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}
204 Successfully deleted. string

Update Space beta

PATCH/api/3.1/spaces/{space_id}
update_space(space_id, body)

Implementation Notes

Update the space with a specific id.

Response Class

Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space string string
body true Space body
Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

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
}

Get All Spaces beta

GET/api/3.1/spaces
all_spaces(fields)

Implementation Notes

Get information about all spaces.

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 Space beta

POST/api/3.1/spaces
create_space(body)

Implementation Notes

Create a space with specified information.

Caller must have permission to edit the parent space and to create spaces, otherwise the request returns 404 Not Found.

Response Class

Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Create a new space body
Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

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
}

Get Space Children beta

GET/api/3.1/spaces/{space_id}/children
space_children(space_id, fields, page, per_page, sorts)

Implementation Notes

Get the children of a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space string string
fields false Requested fields. string string
page false Requested page. integer int64
per_page false Results per page. integer int64
sorts false Fields to sort by. 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
}

Search Space Children beta

GET/api/3.1/spaces/{space_id}/children/search
space_children_search(space_id, fields, sorts, name)

Implementation Notes

Search the children of a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space string string
fields false Requested fields. string string
sorts false Fields to sort by. string string
name false Match Space name. 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 Space Parent beta

GET/api/3.1/spaces/{space_id}/parent
space_parent(space_id, fields)

Implementation Notes

Get the parent of a space.

Response Class

Space {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, required): Unique Name,
parent_id (string, required): Id of Parent,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): 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 (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User,
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
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
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,
id (string, read-only): Unique Id,
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,
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,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, 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 (long, 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 (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,
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 (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
dashboards (Array[DashboardBase], read-only): Dashboards,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}

Get Space Ancestors beta

GET/api/3.1/spaces/{space_id}/ancestors
space_ancestors(space_id, fields)

Implementation Notes

Get the ancestors of a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}

Get Space Looks beta

GET/api/3.1/spaces/{space_id}/looks
space_looks(space_id, fields)

Implementation Notes

Get the looks in a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}

Get Space Dashboards beta

GET/api/3.1/spaces/{space_id}/dashboards
space_dashboards(space_id, fields)

Implementation Notes

Get the dashboards in a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space 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
}
Top