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

Search Folders beta

GET/api/4.0/folders/search
search_folders(fields, page, per_page, limit, offset, sorts, name, id, parent_id, creator_id, filter_or)

Implementation Notes

Search for folders by creator id, parent id, name, etc.

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 folder. string string
creator_id false Filter on folder 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 Folder beta

GET/api/4.0/folders/{folder_id}
folder(folder_id, fields)

Implementation Notes

Get information about the folder with a specific id.

Response Class

Folder {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, 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,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
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,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, 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
}
LookWithDashboards {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder of this Look,
space_id (string): Space Id,
folder_id (string): Folder Id,
updated_at (date-time, read-only): Time that the Look was updated.,
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
}

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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 Folder beta

DELETE/api/4.0/folders/{folder_id}
delete_folder(folder_id)

Implementation Notes

Delete the folder with a specific id including any children folders.

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

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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

Update Folder beta

PATCH/api/4.0/folders/{folder_id}
update_folder(folder_id, body)

Implementation Notes

Update the folder with a specific id.

Response Class

Folder {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, 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,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
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,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, 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
}
LookWithDashboards {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder of this Look,
space_id (string): Space Id,
folder_id (string): Folder Id,
updated_at (date-time, read-only): Time that the Look was updated.,
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
}

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder string string
body true Folder parameters body
UpdateFolder {
name (string): Unique Name,
parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry
}

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
}

Get All Folders beta

GET/api/4.0/folders
all_folders(fields)

Implementation Notes

Get information about all folders.

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

POST/api/4.0/folders
create_folder(body)

Implementation Notes

Create a folder with specified information.

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

Response Class

Folder {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, 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,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
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,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, 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
}
LookWithDashboards {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder of this Look,
space_id (string): Space Id,
folder_id (string): Folder Id,
updated_at (date-time, read-only): Time that the Look was updated.,
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
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Folder parameters body
CreateFolder {
name (string, required): Unique Name,
parent_id (string, required): Id of Parent. If the parent id is null, this is a root-level entry
}

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
}

Get Folder Children beta

GET/api/4.0/folders/{folder_id}/children
folder_children(folder_id, fields, page, per_page, sorts)

Implementation Notes

Get the children of a folder.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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 Folder Children beta

GET/api/4.0/folders/{folder_id}/children/search
folder_children_search(folder_id, fields, sorts, name)

Implementation Notes

Search the children of a folder.

Response Class

  array

Parameters

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

GET/api/4.0/folders/{folder_id}/parent
folder_parent(folder_id, fields)

Implementation Notes

Get the parent of a folder.

Response Class

Folder {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, 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,
dashboards (Array[DashboardBase], read-only): Dashboards,
looks (Array[LookWithDashboards], read-only): Looks
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the space was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
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,
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,
can (object, read-only): Operations the current user is able to perform on this object
}
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 (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, 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
}
LookWithDashboards {
can (object, read-only): Operations the current user is able to perform on this object,
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,
folder (FolderBase, read-only): Folder of this Look,
space_id (string): Space Id,
folder_id (string): Folder Id,
updated_at (date-time, read-only): Time that the Look was updated.,
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
}

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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 Folder Ancestors beta

GET/api/4.0/folders/{folder_id}/ancestors
folder_ancestors(folder_id, fields)

Implementation Notes

Get the ancestors of a folder.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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 Folder Looks beta

GET/api/4.0/folders/{folder_id}/looks
folder_looks(folder_id, fields)

Implementation Notes

Get the looks in a folder.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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 Folder Dashboards beta

GET/api/4.0/folders/{folder_id}/dashboards
folder_dashboards(folder_id, fields)

Implementation Notes

Get the dashboards in a folder.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
folder_id true Id of folder 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