Version 4.0.24.16
Search Dashboards
Returns an array of user-defined dashboard objects that match the specified search criteria. Note, search_dashboards() does not return LookML dashboard objects.
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()
Request
GET
/dashboards/search
Datatype
Description
Request
query
Expand HTTP Query definition...
id
Match dashboard id.
slug
Match dashboard slug.
title
Match Dashboard title.
description
Match Dashboard description.
content_favorite_id
Filter on a content favorite id.
folder_id
Filter on a particular folder.
deleted
Filter on dashboards deleted status.
user_id
Filter on dashboards created by a particular user.
view_count
Filter on a particular value of view_count
content_metadata_id
Filter on a content favorite id.
curate
Exclude items that exist only in personal spaces other than the users
last_viewed_at
Select dashboards based on when they were last viewed
fields
Requested fields.
page
DEPRECATED. Use limit and offset instead. Return only page N of paginated results
per_page
DEPRECATED. Use limit and offset instead. Return N rows of data per page
limit
Number of results to return. (used with offset and takes priority over page and per_page)
offset
Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
sorts
One or more fields to sort by. Sortable fields: [:title, :user_id, :id, :created_at, :space_id, :folder_id, :description, :view_count, :favorite_count, :slug, :content_favorite_id, :content_metadata_id, :deleted, :deleted_at, :last_viewed_at, :last_accessed_at]
filter_or
Combine given search criteria in a boolean OR expression
not_owned_by
Filter out the dashboards owned by the user passed at the :user_id params
Response
200: dashboards
Datatype
Description
(array)
can
lock
Operations the current user is able to perform on this object
content_favorite_id
lock
Content Favorite Id
content_metadata_id
lock
Id of content metadata
description
Description
hidden
Is Hidden
id
lock
Unique Id
model
lock
Model
Expand LookModel definition...
id
lock
Model Id
label
lock
Model Label
query_timezone
Timezone in which the Dashboard will run by default.
readonly
lock
Is Read-only
refresh_interval
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
lock
Refresh Interval in milliseconds
folder
lock
Folder
Expand FolderBase definition...
name
Unique Name
parent_id
Id of Parent. If the parent id is null, this is a root-level entry
id
lock
Unique Id
content_metadata_id
lock
Id of content metadata
created_at
lock
Time the folder was created
creator_id
lock
User Id of Creator
child_count
lock
Children Count
external_id
lock
Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login
is_embed
lock
Folder is an embed folder
is_embed_shared_root
lock
Folder is the root embed shared folder
is_embed_users_root
lock
Folder is the root embed users folder
is_personal
lock
Folder is a user's personal folder
is_personal_descendant
lock
Folder is descendant of a user's personal folder
is_shared_root
lock
Folder is the root shared folder
is_users_root
lock
Folder is the root user folder
can
lock
Operations the current user is able to perform on this object
title
Dashboard Title
user_id
lock
Id of User
slug
Content Metadata Slug
preferred_viewer
The preferred route for viewing this dashboard (ie: dashboards or dashboards-next)
alert_sync_with_dashboard_filter_enabled
Enables alerts to keep in sync with dashboard filter changes
background_color
Background color
created_at
lock
Time that the Dashboard was created.
crossfilter_enabled
Enables crossfiltering in dashboards - only available in dashboards-next (beta)
dashboard_elements
Expand DashboardElement definition...
can
lock
Operations the current user is able to perform on this object
body_text
Text tile body text
body_text_as_html
lock
Text tile body text as Html
dashboard_id
Id of Dashboard
edit_uri
lock
Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).
id
lock
Unique Id
look
lock
Look
Expand LookWithQuery definition...
can
lock
Operations the current user is able to perform on this object
content_metadata_id
lock
Id of content metadata
id
lock
Unique Id
title
Look Title
user_id
User Id
content_favorite_id
lock
Content Favorite Id
created_at
lock
Time that the Look was created.
deleted
Whether or not a look is 'soft' deleted.
deleted_at
lock
Time that the Look was deleted.
deleter_id
lock
Id of User that deleted the look.
description
Description
embed_url
lock
Embed Url
excel_file_url
lock
Excel File Url
favorite_count
lock
Number of times favorited
google_spreadsheet_formula
lock
Google Spreadsheet Formula
image_embed_url
lock
Image Embed Url
is_run_on_load
auto-run query when Look viewed
last_accessed_at
lock
Time that the Look was last accessed by any user
last_updater_id
lock
Id of User that last updated the look.
last_viewed_at
lock
Time last viewed in the Looker web UI
model
lock
Model
public
Is Public
public_slug
lock
Public Slug
public_url
lock
Public Url
query_id
Query Id
short_url
lock
Short Url
folder
lock
Folder of this Look
folder_id
Folder Id
updated_at
lock
Time that the Look was updated.
view_count
lock
Number of times viewed in the Looker web UI
query
lock
Query
url
lock
Url
look_id
Id Of Look
lookml_link_id
lock
LookML link ID
merge_result_id
ID of merge result
note_display
Note Display
note_state
Note State
note_text
Note Text
note_text_as_html
lock
Note Text as Html
query
lock
Query
Expand Query definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
model
Model
view
Explore Name
fields
pivots
fill_fields
filters
Filters will contain data pertaining to complex filters that do not contain "or" conditions. When "or" conditions are present, filter data will be found on the `filter_expression` property.
filter_expression
Filter Expression
sorts
limit
Limit
column_limit
Column Limit
total
Total
row_total
Raw Total
subtotals
vis_config
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
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
Visible UI Sections
slug
lock
Slug
dynamic_fields
Dynamic Fields
client_id
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
lock
Share Url
expanded_share_url
lock
Expanded Share Url
url
lock
Expanded Url
query_timezone
Query Timezone
has_table_calculations
lock
Has Table Calculations
query_id
Id Of Query
refresh_interval
Refresh Interval
refresh_interval_to_i
lock
Refresh Interval as integer
result_maker
Data about the result maker.
Expand ResultMakerWithIdVisConfigAndDynamicFields definition...
id
lock
Unique Id.
dynamic_fields
lock
JSON string of dynamic field information.
filterables
sorts
merge_result_id
lock
ID of merge result if this is a merge_result.
total
lock
Total of the constituent Look, Query, or Merge Query
query_id
lock
ID of query if this is a query.
sql_query_id
lock
ID of SQL Query if this is a SQL Runner Query
query
lock
Query
vis_config
lock
Vis config of the constituent Query, or Merge Query.
result_maker_id
ID of the ResultMakerLookup entry.
subtitle_text
Text tile subtitle text
title
Title of dashboard element
title_hidden
Whether title is hidden
title_text
Text tile title
type
Type
alert_count
lock
Count of Alerts associated to a dashboard element
rich_content_json
JSON with all the properties required for rich editor and buttons elements
title_text_as_html
lock
Text tile title text as Html
subtitle_text_as_html
lock
Text tile subtitle text as Html
extension_id
Extension ID
dashboard_filters
Expand DashboardFilter definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_id
lock
Id of Dashboard
name
Name of filter
title
Title of filter
type
Type of filter: one of date, number, string, or field
default_value
Default value of filter
model
Model of filter (required if type = field)
explore
Explore of filter (required if type = field)
dimension
Dimension of filter (required if type = field)
field
lock
Field information
row
Display order of this filter relative to other filters
listens_to_filters
allow_multiple_values
Whether the filter allows multiple filter values (deprecated in the latest version of dashboards)
required
Whether the filter requires a value to run the dashboard
ui_config
The visual configuration for this filter. Used to set up how the UI for this filter should appear.
dashboard_layouts
Expand DashboardLayout definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_id
Id of Dashboard
type
Type
active
Is Active
column_width
Column Width
width
Width
deleted
lock
Whether or not the dashboard layout is deleted.
dashboard_title
lock
Title extracted from the dashboard this layout represents.
dashboard_layout_components
Expand DashboardLayoutComponent definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
dashboard_layout_id
Id of Dashboard Layout
dashboard_element_id
Id Of Dashboard Element
row
Row
column
Column
width
Width
height
Height
deleted
lock
Whether or not the dashboard layout component is deleted
element_title
lock
Dashboard element title, extracted from the Dashboard Element.
element_title_hidden
lock
Whether or not the dashboard element title is displayed.
vis_type
lock
Visualization type, extracted from a query's vis_config
deleted
Whether or not a dashboard is 'soft' deleted.
deleted_at
lock
Time that the Dashboard was 'soft' deleted.
deleter_id
lock
Id of User that 'soft' deleted the dashboard.
edit_uri
lock
Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).
enable_viz_full_screen
Allow visualizations to be viewed in full screen mode
favorite_count
lock
Number of times favorited
filters_bar_collapsed
Sets the default state of the filters bar to collapsed or open
filters_location_top
Sets the default state of the filters location to top(true) or right(false)
last_accessed_at
lock
Time the dashboard was last accessed
last_viewed_at
lock
Time last viewed in the Looker web UI
updated_at
lock
Time that the Dashboard was most recently updated.
last_updater_id
lock
Id of User that most recently updated the dashboard.
last_updater_name
lock
Name of User that most recently updated the dashboard.
user_name
lock
Name of User that created the dashboard.
load_configuration
configuration option that governs how dashboard loading will happen.
lookml_link_id
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
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](https://cloud.google.com/looker/docs/r/api/control-access)
show_title
Show title
folder_id
Id of folder
text_tile_text_color
Color of text on text tiles
tile_background_color
Tile background color
tile_text_color
Tile text color
title_color
Title color
view_count
lock
Number of times viewed in the Looker web UI
appearance
Dashboard visual settings only applicable to dashboards-next (beta)
Expand DashboardAppearance definition...
page_side_margins
Page margin (side) width
page_background_color
Background color for the dashboard
tile_title_alignment
Title alignment on dashboard tiles
tile_space_between
Space between tiles
tile_background_color
Background color for tiles
tile_shadow
Tile shadow on/off
key_color
Key color
url
lock
Relative URL of the dashboard
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
TypeScript
Kotlin
Swift