Search LookML Dashboards

Version 4.0.25.18 (latest)

Search LookML Dashboards

Returns an array of LookML Dashboard objects that match the specified search criteria. Note, this only returns LookML Dashboards in production.

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 LookML dashboard by id with dashboard_lookml()

Request

GET /dashboards/lookml/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
folder_id
string
Filter on a particular folder.
title
string
Match LookML Dashboard title.
content_favorite_id
string
Filter on a content favorite id.
fields
string
Requested fields.
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, :id, :folder_id, :content_favorite_id, :content_metadata_id]

Response

200: dashboards

Datatype
Description
(object)
dashboard_id
string
Id of Dashboard
folder_id
string
(Write-Only) Id of the folder
lookml
string
lookml of UDD

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link