Version 4.0.25.14 (latest)
Search Boards
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 anyof 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.
Request
GET
/boards/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
title
string
Matches board title.
created_at
string
Matches the timestamp for when the board was created.
first_name
string
The first name of the user who created this board.
last_name
string
The last name of the user who created this board.
fields
string
Requested fields.
favorited
boolean
Return favorited boards when true.
creator_id
string
Filter on boards created by a particular user.
sorts
string
The fields to sort the results by
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
offset
integer
Number of results to return. (used with offset and takes priority over page and per_page)
limit
integer
Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
filter_or
boolean
Combine given search criteria in a boolean OR expression
permission
string
Filter results based on permission, either show (default) or update
Response
200: boards
Datatype
Description
(array)
Board
[]
can
lock
object
Operations the current user is able to perform on this object
content_metadata_id
lock
string
Id of associated content_metadata record
created_at
lock
string
Date of board creation
deleted_at
string
Date of board deletion
description
string
Description of the board
board_sections
BoardSection
[]
Expand BoardSection definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Time at which this section was created.
deleted_at
string
Time at which this section was deleted.
description
string
Description of the content found in this section.
board_id
string
Id reference to parent board
board_items
BoardItem
[]
Expand BoardItem definition...
can
lock
object
Operations the current user is able to perform on this object
content_created_by
lock
string
Name of user who created the content this item is based on
content_favorite_id
lock
string
Content favorite id associated with the item this content is based on
content_metadata_id
lock
string
Content metadata id associated with the item this content is based on
content_updated_at
lock
string
Last time the content that this item is based on was updated
custom_description
string
Custom description entered by the user, if present
custom_title
string
Custom title entered by the user, if present
custom_url
string
Custom url entered by the user, if present
dashboard_id
string
Dashboard to base this item on
description
lock
string
The actual description for display
favorite_count
lock
integer
Number of times content has been favorited, if present
board_section_id
string
Associated Board Section
id
lock
string
Unique Id
image_url
lock
string
The actual image_url for display
location
lock
string
The container folder name of the content
look_id
string
Look to base this item on
lookml_dashboard_id
string
LookML Dashboard to base this item on
order
integer
An arbitrary integer representing the sort order within the section
title
lock
string
The actual title for display
url
lock
string
Relative url for the associated content
use_custom_description
boolean
Whether the custom description should be used instead of the content description, if the item is associated with content
use_custom_title
boolean
Whether the custom title should be used instead of the content title, if the item is associated with content
use_custom_url
boolean
Whether the custom url should be used instead of the content url, if the item is associated with content
view_count
lock
integer
Number of times content has been viewed, if present
custom_image_data_base64
string
(Write-Only) base64 encoded image data
custom_image_url
lock
string
Custom image_url entered by the user, if present
use_custom_image
boolean
Whether the custom image should be used instead of the content image, if the item is associated with content
id
lock
string
Unique Id
item_order
string[]
visible_item_order
string[]
title
string
Name of row
updated_at
lock
string
Time at which this section was last updated.
id
lock
string
Unique Id
section_order
string[]
title
string
Title of the board
updated_at
lock
string
Date of last board update
user_id
lock
string
User id of board creator
primary_homepage
lock
boolean
Whether the board is the primary homepage or not
400: Bad Request
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
string
Error details
documentation_url
lock
string
Documentation link
