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

Get All Dashboards beta

GET/api/3.1/dashboards
all_dashboards(fields)

Implementation Notes

Get information about all active dashboards.

Returns an array of abbreviated dashboard objects. Dashboards marked as deleted are excluded from this list.

Get the full details of a specific dashboard by id with dashboard())

Find deleted dashboards with search_dashboards())

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

POST/api/3.1/dashboards
create_dashboard(body)

Implementation Notes

Create a new dashboard.

Creates a new dashboard object and returns the details of the newly created dashboard.

Title, user_id, and space_id are all required fields. Space_id and user_id must contain the id of an existing space or user, respectively. A dashboard’s title must be unique within the space in which it resides.

If you receive a 422 error response when creating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data.

You can update an existing dashboard with update_dashboard())

You can permanently delete an existing dashboard with delete_dashboard())

Response Class

Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
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 Dashboard body
Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
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
}

Search Dashboards beta

GET/api/3.1/dashboards/search
search_dashboards(id, slug, title, description, content_favorite_id, space_id, deleted, user_id, view_count, content_metadata_id, fields, page, per_page, limit, offset, sorts, filter_or)

Implementation Notes

Search Dashboards.

Returns an array of dashboard objects that match the specified search criteria.

If multiple search params are given and filter_or is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned.

If filter_or is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria.

String search params use case-insensitive matching. String search params can contain % and ‘_’ as SQL LIKE pattern match wildcard expressions. example=”dan%” will match “danger” and “Danzig” but not “David” example=”D_m%” will match “Damage” and “dump”

Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values.

Most search params can accept “IS NULL” and “NOT NULL” as special expressions to match or exclude (respectively) rows where the column is null.

Boolean search params accept only “true” and “false” as values.

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

Get a single dashboard by id with dashboard())

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
id false Match dashboard id. integer int64
slug false Match dashboard slug. string string
title false Match Dashboard title. string string
description false Match Dashboard description. string string
content_favorite_id false Filter on a content favorite id. integer int64
space_id false Filter on a particular space. string string
deleted false Filter on dashboards deleted status. string string
user_id false Filter on dashboards created by a particular user. string string
view_count false Filter on a particular value of view_count string string
content_metadata_id false Filter on a content favorite id. integer int64
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 One or more fields to sort by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at] 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
}

Import LookML Dashboard beta

POST/api/3.1/dashboards/{lookml_dashboard_id}/import/{space_id}
import_lookml_dashboard(lookml_dashboard_id, space_id, body, raw_locale)

Implementation Notes

Import a LookML dashboard to a space as a UDD.

Creates a UDD (a dashboard which exists in the Looker database rather than as a LookML file) from the LookML dashboard and puts it in the space specified. The created UDD will have a lookml_link_id which links to the original LookML dashboard.

To give the imported dashboard specify a (e.g. title: “my title”) in the body of your request, otherwise the imported dashboard will have the same title as the original LookML dashboard.

For this operation to succeed the user must have permission to see the LookML dashboard in question, and have permission to create content in the space the dashboard is being imported to.

Sync a linked UDD with sync_lookml_dashboard()) Unlink a linked UDD by setting lookml_link_id to null with update_dashboard())

Response Class

Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
lookml_dashboard_id true Id of LookML dashboard string string
space_id true Id of space to import the dashboard to string string
body false Dashboard body
Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
raw_locale false If true, and this dashboard is localized, export it with the raw keys, not localized. boolean boolean

Response Messages

HTTP Status Code Reason Response Model
201 dashboard
Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Sync LookML Dashboard beta

PATCH/api/3.1/dashboards/{lookml_dashboard_id}/sync
sync_lookml_dashboard(lookml_dashboard_id, body, raw_locale)

Implementation Notes

Update all linked dashboards to match the specified LookML dashboard.

Any UDD (a dashboard which exists in the Looker database rather than as a LookML file) which has a lookml_link_id property value referring to a LookML dashboard’s id (model::dashboardname) will be updated so that it matches the current state of the LookML dashboard.

For this operation to succeed the user must have permission to view the LookML dashboard, and only linked dashboards that the user has permission to update will be synced.

To link or unlink a UDD set the lookml_link_id property with update_dashboard())

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
lookml_dashboard_id true Id of LookML dashboard, in the form ‘model::dashboardname’ string string
body true Dashboard body
Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
raw_locale false If true, and this dashboard is localized, export it with the raw keys, not localized. boolean boolean

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Delete Dashboard beta

DELETE/api/3.1/dashboards/{dashboard_id}
delete_dashboard(dashboard_id)

Implementation Notes

Delete the dashboard with the specified id.

Permanently deletes a dashboard. (The dashboard cannot be recovered after this operation.)

“Soft” delete or hide a dashboard by setting its deleted status to True with update_dashboard()).

Note: When a dashboard is deleted in the UI, it is soft deleted. Use this API call to permanently remove it, if desired.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_id true Id of dashboard string string

Response Messages

HTTP Status Code Reason Response Model
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
405 Resource Can’t Be Modified
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Update Dashboard beta

PATCH/api/3.1/dashboards/{dashboard_id}
update_dashboard(dashboard_id, body)

Implementation Notes

Update a dashboard.

You can use this function to change the string and integer properties of a dashboard. Nested objects such as filters, dashboard elements, or dashboard layout components cannot be modified by this function - use the update functions for the respective nested object types (like update_dashboard_filter()) to change a filter) to modify nested objects referenced by a dashboard.

If you receive a 422 error response when updating a dashboard, be sure to look at the response body for information about exactly which fields are missing or contain invalid data.

Response Class

Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_id true Id of dashboard string string
body true Dashboard body
Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
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
}
405 Resource Can’t Be Modified
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Dashboard beta

GET/api/3.1/dashboards/{dashboard_id}
dashboard(dashboard_id, fields)

Implementation Notes

Get information about a dashboard.

Returns the full details of the identified dashboard object

Get a summary list of all active dashboards with all_dashboards())

You can Search for dashboards with search_dashboards())

Response Class

Dashboard {
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string): Description,
hidden (boolean): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
space (SpaceBase, read-only): Space,
title (string): Dashboard Title,
user_id (long, read-only): Id of User,
background_color (string): Background color,
created_at (date-time, read-only): Time that the Dashboard was created.,
dashboard_elements (Array[DashboardElement], read-only): Elements,
dashboard_filters (Array[DashboardFilter], read-only): Filters,
dashboard_layouts (Array[DashboardLayout], read-only): Layouts,
deleted (boolean): Whether or not a dashboard is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Dashboard was 'soft' deleted.,
deleter_id (long, read-only): Id of User that 'soft' deleted the dashboard.,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).,
favorite_count (long, read-only): Number of times favorited,
last_accessed_at (date-time, read-only): Time the dashboard was last accessed,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
load_configuration (string): configuration option that governs how dashboard loading will happen.,
lookml_link_id (string): Links this dashboard to a particular LookML dashboard such that calling a sync operation on that LookML dashboard will update this dashboard to match.,
show_filters_bar (boolean): Show filters bar. Security Note: This property only affects the cosmetic appearance of the dashboard, not a user's ability to access data. Hiding the filters bar does NOT prevent users from changing filters by other means. For information on how to set up secure data access control policies, see Control User Access to Data,
show_title (boolean): Show title,
slug (string): Content Metadata Slug,
space_id (string): Id of Space,
text_tile_text_color (string): Color of text on text tiles,
tile_background_color (string): Tile background color,
tile_text_color (string): Tile text color,
title_color (string): Title color,
view_count (long, read-only): Number of times viewed in the Looker web UI,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

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

Search Dashboard Elements beta

GET/api/3.1/dashboard_elements/search
search_dashboard_elements(dashboard_id, look_id, title, deleted, fields, filter_or, sorts)

Implementation Notes

Search Dashboard Elements.

Returns an array of DashboardElement objects that match the specified search criteria.

If multiple search params are given and filter_or is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned.

If filter_or is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria.

String search params use case-insensitive matching. String search params can contain % and ‘_’ as SQL LIKE pattern match wildcard expressions. example=”dan%” will match “danger” and “Danzig” but not “David” example=”D_m%” will match “Damage” and “dump”

Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values.

Most search params can accept “IS NULL” and “NOT NULL” as special expressions to match or exclude (respectively) rows where the column is null.

Boolean search params accept only “true” and “false” as values.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_id false Select elements that refer to a given dashboard id integer int64
look_id false Select elements that refer to a given look id integer int64
title false Match the title of element string string
deleted false Select soft-deleted dashboard elements boolean boolean
fields false Requested fields. string string
filter_or false Combine given search criteria in a boolean OR expression boolean boolean
sorts false Fields to sort by. Sortable fields: [:look_id, :dashboard_id, :deleted, :title] 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 DashboardElement beta

GET/api/3.1/dashboard_elements/{dashboard_element_id}
dashboard_element(dashboard_element_id, fields)

Implementation Notes

Get information about the dashboard element with a specific id.

Response Class

DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_element_id true Id of dashboard element 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 DashboardElement beta

DELETE/api/3.1/dashboard_elements/{dashboard_element_id}
delete_dashboard_element(dashboard_element_id)

Implementation Notes

Delete a dashboard element with a specific id.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_element_id true Id of dashboard element 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 DashboardElement beta

PATCH/api/3.1/dashboard_elements/{dashboard_element_id}
update_dashboard_element(dashboard_element_id, body, fields)

Implementation Notes

Update the dashboard element with a specific id.

Response Class

DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_element_id true Id of dashboard element string string
body true DashboardElement body
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get All DashboardElements beta

GET/api/3.1/dashboards/{dashboard_id}/dashboard_elements
dashboard_dashboard_elements(dashboard_id, fields)

Implementation Notes

Get information about all the dashboard elements on a dashboard with a specific id.

Response Class

  array

Parameters

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

Create DashboardElement beta

POST/api/3.1/dashboard_elements
create_dashboard_element(body, fields)

Implementation Notes

Create a dashboard element on the dashboard with a specific id.

Response Class

DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false DashboardElement body
DashboardElement {
body_text (string): Text tile body text,
body_text_as_html (string, read-only): Text tile body text as Html,
dashboard_id (string): Id of Dashboard,
edit_uri (string, read-only): Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).,
id (string, read-only): Unique Id,
look (LookWithQuery, read-only): Look,
look_id (string): Id Of Look,
lookml_link_id (string, read-only): LookML link ID,
merge_result_id (string): ID of merge result,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query (Query, read-only): Query,
query_id (long): Id Of Query,
refresh_interval (string): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as integer,
result_maker (ResultMakerWithIdVisConfigAndDynamicFields): Data about the result maker.,
result_maker_id (long, read-only): ID of the ResultMakerLookup entry.,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type,
alert_count (long, read-only): Count of Alerts associated to a dashboard element,
can (object, read-only): Operations the current user is able to perform on this object
}
LookWithQuery {
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string): Look Title,
content_favorite_id (long, read-only): Content Favorite Id,
created_at (date-time, read-only): Time that the Look was created.,
deleted (boolean): Whether or not a look is 'soft' deleted.,
deleted_at (date-time, read-only): Time that the Look was deleted.,
deleter_id (long, read-only): Id of User that deleted the look.,
description (string): Description,
embed_url (string, read-only): Embed Url,
excel_file_url (string, read-only): Excel File Url,
favorite_count (long, read-only): Number of times favorited,
google_spreadsheet_formula (string, read-only): Google Spreadsheet Formula,
image_embed_url (string, read-only): Image Embed Url,
is_run_on_load (boolean): auto-run query when Look viewed,
last_accessed_at (date-time, read-only): Time that the Look was last accessed by any user,
last_updater_id (long, read-only): Id of User that last updated the look.,
last_viewed_at (date-time, read-only): Time last viewed in the Looker web UI,
model (LookModel, read-only): Model,
public (boolean): Is Public,
public_slug (string, read-only): Public Slug,
public_url (string, read-only): Public Url,
query_id (long): Query Id,
short_url (string, read-only): Short Url,
space (SpaceBase, read-only): Space of this Look,
space_id (string): Space Id,
updated_at (date-time, read-only): Time that the Look was updated.,
user (UserIdOnly, read-only): User,
user_id (long): User Id,
view_count (long, read-only): Number of times viewed in the Looker web UI,
query (Query, read-only): Query,
url (string, read-only): Url,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
SpaceBase {
child_count (long, read-only): Children Count,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
id (string, read-only): Unique Id,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
name (string, read-only): Unique Name,
parent_id (string, required): Id of Parent,
can (object, read-only): Operations the current user is able to perform on this object
}
UserIdOnly {
id (long, read-only): Unique Id
}
Query {
id (long, read-only): Unique Id,
model (string, required): Model,
view (string, required): Explore Name,
fields (Array[string]): Fields,
pivots (Array[string]): Pivots,
fill_fields (Array[string]): Fill Fields,
filters (object): Filters,
filter_expression (string): Filter Expression,
sorts (Array[string]): Sorting for the query results. Use the format ["view.field", ...] to sort on fields in ascending order. Use the format ["view.field desc", ...] to sort on fields in descending order. Use ["__UNSORTED__"] (2 underscores before and after) to disable sorting entirely. Empty sorts [] will trigger a default sort.,
limit (string): Limit,
column_limit (string): Column Limit,
total (boolean): Total,
row_total (string): Raw Total,
subtotals (Array[string]): Fields on which to run subtotals,
runtime (double): Runtime,
vis_config (object): Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.,
filter_config (object): The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.,
visible_ui_sections (string): Visible UI Sections,
slug (string, read-only): Slug,
dynamic_fields (string): Dynamic Fields,
client_id (string): Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.,
share_url (string, read-only): Share Url,
expanded_share_url (string, read-only): Expanded Share Url,
url (string, read-only): Expanded Url,
query_timezone (string): Query Timezone,
has_table_calculations (boolean, read-only): Has Table Calculations,
can (object, read-only): Operations the current user is able to perform on this object
}
ResultMakerWithIdVisConfigAndDynamicFields {
id (long, read-only): Unique Id.,
dynamic_fields (string, read-only): JSON string of dynamic field information.,
filterables (Array[ResultMakerFilterables], read-only): array of items that can be filtered and information about them.,
sorts (string, read-only): Sorts of the constituent Look, Query, or Merge Query,
merge_result_id (string, read-only): ID of merge result if this is a merge_result.,
total (boolean, read-only): Total of the constituent Look, Query, or Merge Query,
query_id (long, read-only): ID of query if this is a query.,
query (Query, read-only): Query,
vis_config (string, read-only): Vis config of the constituent Query, or Merge Query.
}
ResultMakerFilterables {
model (string, read-only): The model this filterable comes from (used for field suggestions).,
view (string, read-only): The view this filterable comes from (used for field suggestions).,
name (string, read-only): The name of the filterable thing (Query or Merged Results).,
listen (Array[ResultMakerFilterablesListen], read-only): array of dashboard_filter_name: and field: objects.
}
ResultMakerFilterablesListen {
dashboard_filter_name (string): The name of a dashboard filter to listen to.,
field (string): The name of the field in the filterable to filter with the value of the dashboard filter.
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get Dashboard Filter beta

GET/api/3.1/dashboard_filters/{dashboard_filter_id}
dashboard_filter(dashboard_filter_id, fields)

Implementation Notes

Get information about the dashboard filters with a specific id.

Response Class

DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_filter_id true Id of dashboard filters 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 Dashboard Filter beta

DELETE/api/3.1/dashboard_filters/{dashboard_filter_id}
delete_dashboard_filter(dashboard_filter_id)

Implementation Notes

Delete a dashboard filter with a specific id.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_filter_id true Id of dashboard filter 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 Dashboard Filter beta

PATCH/api/3.1/dashboard_filters/{dashboard_filter_id}
update_dashboard_filter(dashboard_filter_id, body, fields)

Implementation Notes

Update the dashboard filter with a specific id.

Response Class

DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_filter_id true Id of dashboard filter string string
body true Dashboard Filter body
DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get All Dashboard Filters beta

GET/api/3.1/dashboards/{dashboard_id}/dashboard_filters
dashboard_dashboard_filters(dashboard_id, fields)

Implementation Notes

Get information about all the dashboard filters on a dashboard with a specific id.

Response Class

  array

Parameters

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

Create Dashboard Filter beta

POST/api/3.1/dashboard_filters
create_dashboard_filter(body, fields)

Implementation Notes

Create a dashboard filter on the dashboard with a specific id.

Response Class

DashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Dashboard Filter body
CreateDashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, required): Id of Dashboard,
name (string, required): Name of filter,
title (string, required): Title of filter,
type (string, required): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field),
field (object, read-only): Field information,
row (long): Display order of this filter relative to other filters,
listens_to_filters (Array[string]): Array of listeners for faceted filters,
allow_multiple_values (boolean): Whether the filter allows multiple filter values,
required (boolean): Whether the filter requires a value to run the dashboard,
ui_config (object): The visual configuration for this filter. Used to set up how the UI for this filter should appear.,
can (object, read-only): Operations the current user is able to perform on this object
}
fields false Requested fields string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get DashboardLayoutComponent beta

GET/api/3.1/dashboard_layout_components/{dashboard_layout_component_id}
dashboard_layout_component(dashboard_layout_component_id, fields)

Implementation Notes

Get information about the dashboard elements with a specific id.

Response Class

DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_component_id true Id of dashboard layout component string string
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Update DashboardLayoutComponent beta

PATCH/api/3.1/dashboard_layout_components/{dashboard_layout_component_id}
update_dashboard_layout_component(dashboard_layout_component_id, body, fields)

Implementation Notes

Update the dashboard element with a specific id.

Response Class

DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_component_id true Id of dashboard layout component string string
body true DashboardLayoutComponent body
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get All DashboardLayoutComponents beta

GET/api/3.1/dashboard_layouts/{dashboard_layout_id}/dashboard_layout_components
dashboard_layout_dashboard_layout_components(dashboard_layout_id, fields)

Implementation Notes

Get information about all the dashboard layout components for a dashboard layout with a specific id.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_id true Id of dashboard layout component 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 DashboardLayout beta

GET/api/3.1/dashboard_layouts/{dashboard_layout_id}
dashboard_layout(dashboard_layout_id, fields)

Implementation Notes

Get information about the dashboard layouts with a specific id.

Response Class

DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_id true Id of dashboard layouts 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 DashboardLayout beta

DELETE/api/3.1/dashboard_layouts/{dashboard_layout_id}
delete_dashboard_layout(dashboard_layout_id)

Implementation Notes

Delete a dashboard layout with a specific id.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_id true Id of dashboard layout string string

Response Messages

HTTP Status Code Reason Response Model
204 Successfully deleted. string
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
}

Update DashboardLayout beta

PATCH/api/3.1/dashboard_layouts/{dashboard_layout_id}
update_dashboard_layout(dashboard_layout_id, body, fields)

Implementation Notes

Update the dashboard layout with a specific id.

Response Class

DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
dashboard_layout_id true Id of dashboard layout string string
body true DashboardLayout body
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get All DashboardLayouts beta

GET/api/3.1/dashboards/{dashboard_id}/dashboard_layouts
dashboard_dashboard_layouts(dashboard_id, fields)

Implementation Notes

Get information about all the dashboard elements on a dashboard with a specific id.

Response Class

  array

Parameters

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

Create DashboardLayout beta

POST/api/3.1/dashboard_layouts
create_dashboard_layout(body, fields)

Implementation Notes

Create a dashboard layout on the dashboard with a specific id.

Response Class

DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
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 DashboardLayout body
DashboardLayout {
id (string, read-only): Unique Id,
dashboard_id (string): Id of Dashboard,
type (string): Type,
active (boolean): Is Active,
column_width (long): Column Width,
width (long): Width,
deleted (boolean, read-only): Whether or not the dashboard layout is deleted.,
dashboard_title (string, read-only): Title extracted from the dashboard this layout represents.,
dashboard_layout_components (Array[DashboardLayoutComponent], read-only): Components,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardLayoutComponent {
id (string, read-only): Unique Id,
dashboard_layout_id (string): Id of Dashboard Layout,
dashboard_element_id (string): Id Of Dashboard Element,
row (long): Row,
column (long): Column,
width (long): Width,
height (long): Height,
deleted (boolean, read-only): Whether or not the dashboard layout component is deleted,
element_title (string, read-only): Dashboard element title, extracted from the Dashboard Element.,
element_title_hidden (boolean, read-only): Whether or not the dashboard element title is displayed.,
vis_type (string, read-only): Visualization type, extracted from a query's vis_config,
can (object, read-only): Operations the current user is able to perform on this object
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
Top