Note that you are viewing Looker documentation. For Looker Studio documentation, visit https://support.google.com/looker-studio.

Search Dashboards

Version 4.0.24.20 (latest)

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

HTTP Request

query

HTTP Query

Expand HTTP Query definition...

string

Match dashboard id.

slug

string

Match dashboard slug.

title

string

Match Dashboard title.

description

string

Match Dashboard description.

content_favorite_id

string

Filter on a content favorite id.

folder_id

string

Filter on a particular folder.

deleted

string

Filter on dashboards deleted status.

user_id

string

Filter on dashboards created by a particular user.

view_count

string

Filter on a particular value of view_count

content_metadata_id

string

Filter on a content favorite id.

curate

boolean

Exclude items that exist only in personal spaces other than the users

last_viewed_at

string

Select dashboards based on when they were last viewed

fields

string

Requested fields.

page

integer

DEPRECATED. Use limit and offset instead. Return only page N of paginated results

per_page

integer

DEPRECATED. Use limit and offset instead. Return N rows of data per page

limit

integer

Number of results to return. (used with offset and takes priority over page and per_page)

offset

integer

Number of results to skip before returning any. (used with limit and takes priority over page and per_page)

sorts

string

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

boolean

Combine given search criteria in a boolean OR expression

not_owned_by

boolean

Filter out the dashboards owned by the user passed at the :user_id params

Response

200: dashboards

Datatype

Description

(array)

Dashboard[]

can

object

Operations the current user is able to perform on this object

content_favorite_id

string

Content Favorite Id

content_metadata_id

string

Id of content metadata

description

string

Description

hidden

boolean

Is Hidden

string

Unique Id

model

LookModel

Model

Expand LookModel definition...

string

Model Id

label

string

Model Label

query_timezone

string

Timezone in which the Dashboard will run by default.

readonly

boolean

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

integer

Refresh Interval in milliseconds

folder

FolderBase

Folder

Expand FolderBase definition...

name

string

Unique Name

parent_id

string

Id of Parent. If the parent id is null, this is a root-level entry

string

Unique Id

content_metadata_id

string

Id of content metadata

created_at

string

Time the folder was created

creator_id

string

User Id of Creator

child_count

integer

Children Count

external_id

string

Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login

is_embed

boolean

Folder is an embed folder

is_embed_shared_root

boolean

Folder is the root embed shared folder

is_embed_users_root

boolean

Folder is the root embed users folder

is_personal

boolean

Folder is a user's personal folder

is_personal_descendant

boolean

Folder is descendant of a user's personal folder

is_shared_root

boolean

Folder is the root shared folder

is_users_root

boolean

Folder is the root user folder

can

object

Operations the current user is able to perform on this object

title

string

Dashboard Title

user_id

string

Id of User

slug

string

Content Metadata Slug

preferred_viewer

string

The preferred route for viewing this dashboard (ie: dashboards or dashboards-next)

alert_sync_with_dashboard_filter_enabled

boolean

Enables alerts to keep in sync with dashboard filter changes

background_color

string

Background color

created_at

string

Time that the Dashboard was created.

crossfilter_enabled

boolean

Enables crossfiltering in dashboards - only available in dashboards-next (beta)

dashboard_elements

DashboardElement[]

Expand DashboardElement definition...

can

object

Operations the current user is able to perform on this object

body_text

string

Text tile body text

body_text_as_html

string

Text tile body text as Html

dashboard_id

string

Id of Dashboard

edit_uri

string

Relative path of URI of LookML file to edit the dashboard element (LookML dashboard only).

string

Unique Id

look

LookWithQuery

Look

Expand LookWithQuery definition...

can

object

Operations the current user is able to perform on this object

content_metadata_id

string

Id of content metadata

string

Unique Id

title

string

Look Title

user_id

string

User Id

content_favorite_id

string

Content Favorite Id

created_at

string

Time that the Look was created.

deleted

boolean

Whether or not a look is 'soft' deleted.

deleted_at

string

Time that the Look was deleted.

deleter_id

string

Id of User that deleted the look.

description

string

Description

embed_url

string

Embed Url

excel_file_url

string

Excel File Url

favorite_count

integer

Number of times favorited

google_spreadsheet_formula

string

Google Spreadsheet Formula

image_embed_url

string

Image Embed Url

is_run_on_load

boolean

auto-run query when Look viewed

last_accessed_at

string

Time that the Look was last accessed by any user

last_updater_id

string

Id of User that last updated the look.

last_viewed_at

string

Time last viewed in the Looker web UI

model

LookModel

Model

public

boolean

Is Public

public_slug

string

Public Slug

public_url

string

Public Url

query_id

string

Query Id

short_url

string

Short Url

folder

FolderBase

Folder of this Look

folder_id

string

Folder Id

updated_at

string

Time that the Look was updated.

user_name

string

Name of User that created the look.

view_count

integer

Number of times viewed in the Looker web UI

query

Query

url

string

Url

look_id

string

Id Of Look

lookml_link_id

string

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

Note Text as Html

query

Query

Expand Query definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

model

string

Model

view

string

Explore Name

fields

string[]

pivots

string[]

fill_fields

string[]

filters

object

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

string

Filter Expression

sorts

string[]

limit

string

Row limit. To download unlimited results, set the limit to -1 (negative one).

column_limit

string

Column Limit

total

boolean

Total

row_total

string

Raw Total

subtotals

string[]

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

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

Share Url

expanded_share_url

string

Expanded Share Url

url

string

Expanded Url

query_timezone

string

Query Timezone

has_table_calculations

boolean

Has Table Calculations

query_id

string

Id Of Query

refresh_interval

string

Refresh Interval

refresh_interval_to_i

integer

Refresh Interval as integer

result_maker

ResultMakerWithIdVisConfigAndDynamicFields

Data about the result maker.

Expand ResultMakerWithIdVisConfigAndDynamicFields definition...

string

Unique Id.

dynamic_fields

string

JSON string of dynamic field information.

filterables

ResultMakerFilterables[]

sorts

string[]

merge_result_id

string

ID of merge result if this is a merge_result.

total

boolean

Total of the constituent Look, Query, or Merge Query

query_id

string

ID of query if this is a query.

sql_query_id

string

ID of SQL Query if this is a SQL Runner Query

query

Query

vis_config

object

Vis config of the constituent Query, or Merge Query.

result_maker_id

string

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

integer

Count of Alerts associated to a dashboard element

rich_content_json

string

JSON with all the properties required for rich editor and buttons elements

title_text_as_html

string

Text tile title text as Html

subtitle_text_as_html

string

Text tile subtitle text as Html

extension_id

string

Extension ID

dashboard_filters

DashboardFilter[]

Expand DashboardFilter definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

dashboard_id

string

Id of Dashboard

name

string

Name of filter

title

string

Title of filter

type

string

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

Field information

row

integer

Display order of this filter relative to other filters

listens_to_filters

string[]

allow_multiple_values

boolean

Whether the filter allows multiple filter values (deprecated in the latest version of dashboards)

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.

dashboard_layouts

DashboardLayout[]

Expand DashboardLayout definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

dashboard_id

string

Id of Dashboard

type

string

Type

active

boolean

Is Active

column_width

integer

Column Width

width

integer

Width

deleted

boolean

Whether or not the dashboard layout is deleted.

dashboard_title

string

Title extracted from the dashboard this layout represents.

dashboard_layout_components

DashboardLayoutComponent[]

Expand DashboardLayoutComponent definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

dashboard_layout_id

string

Id of Dashboard Layout

dashboard_element_id

string

Id Of Dashboard Element

row

integer

Row

column

integer

Column

width

integer

Width

height

integer

Height

deleted

boolean

Whether or not the dashboard layout component is deleted

element_title

string

Dashboard element title, extracted from the Dashboard Element.

element_title_hidden

boolean

Whether or not the dashboard element title is displayed.

vis_type

string

Visualization type, extracted from a query's vis_config

deleted

boolean

Whether or not a dashboard is 'soft' deleted.

deleted_at

string

Time that the Dashboard was 'soft' deleted.

deleter_id

string

Id of User that 'soft' deleted the dashboard.

edit_uri

string

Relative path of URI of LookML file to edit the dashboard (LookML dashboard only).

enable_viz_full_screen

boolean

Allow visualizations to be viewed in full screen mode

favorite_count

integer

Number of times favorited

filters_bar_collapsed

boolean

Sets the default state of the filters bar to collapsed or open

filters_location_top

boolean

Sets the default state of the filters location to top(true) or right(false)

last_accessed_at

string

Time the dashboard was last accessed

last_viewed_at

string

Time last viewed in the Looker web UI

updated_at

string

Time that the Dashboard was most recently updated.

last_updater_id

string

Id of User that most recently updated the dashboard.

last_updater_name

string

Name of User that most recently updated the dashboard.

user_name

string

Name of User that created the dashboard.

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](https://cloud.google.com/looker/docs/r/api/control-access)

show_title

boolean

Show title

folder_id

string

Id of folder

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

integer

Number of times viewed in the Looker web UI

appearance

DashboardAppearance

Dashboard visual settings only applicable to dashboards-next (beta)

Expand DashboardAppearance definition...

page_side_margins

integer

Page margin (side) width

page_background_color

string

Background color for the dashboard

tile_title_alignment

string

Title alignment on dashboard tiles

tile_space_between

integer

Space between tiles

tile_background_color

string

Background color for tiles

tile_shadow

boolean

Tile shadow on/off

key_color

string

Key color

url

string

Relative URL of the dashboard

400: Bad Request

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

404: Not Found

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

429: Too Many Requests

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Examples

Search Dashboards