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

Search Spaces beta

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

Implementation Notes

Search for spaces 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 space. string string
creator_id false Filter on dashboards created by a particular user. 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 beta

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

Implementation Notes

Get information about the space with a specific id.

Response Class

Space {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
can (object, read-only): Operations the current user is able to perform on this object
}

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.0/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.0/spaces/{space_id}
update_space(space_id, body)

Implementation Notes

Update the space with a specific id.

Response Class

Space {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
space_id true Id of space string string
body true Space body
Space {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
can (object, read-only): Operations the current user is able to perform on this object
}

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.0/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.0/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 {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
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 Space body
Space {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
can (object, read-only): Operations the current user is able to perform on this object
}

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.0/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.0/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.0/spaces/{space_id}/parent
space_parent(space_id, fields)

Implementation Notes

Get the parent of a space.

Response Class

Space {
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): Unique Name,
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_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_users_root (boolean, read-only): Space is the root user space,
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,
parent_id (long, required): Id of Parent,
looks (Array[LookWithDashboards], read-only): Looks,
dashboards (Array[DashboardBase], read-only): Dashboards,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithDashboards {
id (long, 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,
created_at (date-time, read-only): Time that the Look was created.,
updated_at (date-time, read-only): Time that the Look was updated.,
last_updater_id (long): (Write-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,
deleted_at (date-time, read-only): Time that the Look was deleted.,
is_run_on_load (boolean): auto-run query when Look viewed,
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
}
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
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
can (object, read-only): Operations the current user is able to perform on this object
}

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.0/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.0/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.0/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