home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
Looker keyboard_arrow_down
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Board : Manage Boards

Get All Boards beta

GET/api/4.0/boards
all_boards(fields)

Implementation Notes

Get information about all boards.

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

POST/api/4.0/boards
create_board(body, fields)

Implementation Notes

Create a new board.

Response Class

Board {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of board creation,
deleted_at (date-time): Date of board deletion,
description (string): Description of the board,
board_sections (Array[BoardSection], read-only): Sections of the board,
id (long, read-only): Unique Id,
section_order (Array[long]): ids of the board sections in the order they should be displayed,
title (string): Title of the board,
updated_at (date-time, read-only): Date of last board update,
user_id (long, read-only): User id of board creator,
primary_homepage (boolean, read-only): Whether the board is the primary homepage or not
}
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Board body
Board {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of board creation,
deleted_at (date-time): Date of board deletion,
description (string): Description of the board,
board_sections (Array[BoardSection], read-only): Sections of the board,
id (long, read-only): Unique Id,
section_order (Array[long]): ids of the board sections in the order they should be displayed,
title (string): Title of the board,
updated_at (date-time, read-only): Date of last board update,
user_id (long, read-only): User id of board creator,
primary_homepage (boolean, read-only): Whether the board is the primary homepage or not
}
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Search Boards beta

GET/api/4.0/boards/search
search_boards(title, created_at, first_name, last_name, fields, favorited, creator_id, sorts, page, per_page, offset, limit, filter_or)

Implementation Notes

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 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
title false Matches board title. string string
created_at false Matches the timestamp for when the board was created. string string
first_name false The first name of the user who created this board. string string
last_name false The last name of the user who created this board. string string
fields false Requested fields. string string
favorited false Return favorited boards when true. boolean boolean
creator_id false Filter on boards created by a particular user. string string
sorts false The fields to sort the results by string string
page false The page to return. integer int64
per_page false The number of items in the returned page. integer int64
offset false The number of items to skip before returning any. (used with limit and takes priority over page and per_page) integer int64
limit false The maximum number of items to return. (used with offset and takes priority over page and per_page) integer int64
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
}

Get Board beta

GET/api/4.0/boards/{board_id}
board(board_id, fields)

Implementation Notes

Get information about a board.

Response Class

Board {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of board creation,
deleted_at (date-time): Date of board deletion,
description (string): Description of the board,
board_sections (Array[BoardSection], read-only): Sections of the board,
id (long, read-only): Unique Id,
section_order (Array[long]): ids of the board sections in the order they should be displayed,
title (string): Title of the board,
updated_at (date-time, read-only): Date of last board update,
user_id (long, read-only): User id of board creator,
primary_homepage (boolean, read-only): Whether the board is the primary homepage or not
}
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_id true Id of board integer int64
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 Board beta

PATCH/api/4.0/boards/{board_id}
update_board(board_id, body, fields)

Implementation Notes

Update a board definition.

Response Class

Board {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of board creation,
deleted_at (date-time): Date of board deletion,
description (string): Description of the board,
board_sections (Array[BoardSection], read-only): Sections of the board,
id (long, read-only): Unique Id,
section_order (Array[long]): ids of the board sections in the order they should be displayed,
title (string): Title of the board,
updated_at (date-time, read-only): Date of last board update,
user_id (long, read-only): User id of board creator,
primary_homepage (boolean, read-only): Whether the board is the primary homepage or not
}
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_id true Id of board integer int64
body true Board body
Board {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of board creation,
deleted_at (date-time): Date of board deletion,
description (string): Description of the board,
board_sections (Array[BoardSection], read-only): Sections of the board,
id (long, read-only): Unique Id,
section_order (Array[long]): ids of the board sections in the order they should be displayed,
title (string): Title of the board,
updated_at (date-time, read-only): Date of last board update,
user_id (long, read-only): User id of board creator,
primary_homepage (boolean, read-only): Whether the board is the primary homepage or not
}
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete Board beta

DELETE/api/4.0/boards/{board_id}
delete_board(board_id)

Implementation Notes

Delete a board.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
board_id true Id of board integer int64

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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Get All Board Items beta

GET/api/4.0/board_items
all_board_items(fields, sorts, board_section_id)

Implementation Notes

Get information about all board items.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
fields false Requested fields. string string
sorts false Fields to sort by. string string
board_section_id false Filter to a specific board section 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 Board Item beta

POST/api/4.0/board_items
create_board_item(body, fields)

Implementation Notes

Create a new board item.

Response Class

BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Board Item body
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Board Item beta

GET/api/4.0/board_items/{board_item_id}
board_item(board_item_id, fields)

Implementation Notes

Get information about a board item.

Response Class

BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_item_id true Id of board item integer int64
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 Board Item beta

PATCH/api/4.0/board_items/{board_item_id}
update_board_item(board_item_id, body, fields)

Implementation Notes

Update a board item definition.

Response Class

BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_item_id true Id of board item integer int64
body true Board Item body
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete Board Item beta

DELETE/api/4.0/board_items/{board_item_id}
delete_board_item(board_item_id)

Implementation Notes

Delete a board item.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
board_item_id true Id of board_item integer int64

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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Get All Board sections beta

GET/api/4.0/board_sections
all_board_sections(fields, sorts)

Implementation Notes

Get information about all board sections.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
fields false Requested fields. string string
sorts false Fields to sort by. 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 Board section beta

POST/api/4.0/board_sections
create_board_section(body, fields)

Implementation Notes

Create a new board section.

Response Class

BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Board section body
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Board section beta

GET/api/4.0/board_sections/{board_section_id}
board_section(board_section_id, fields)

Implementation Notes

Get information about a board section.

Response Class

BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_section_id true Id of board section integer int64
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 Board section beta

PATCH/api/4.0/board_sections/{board_section_id}
update_board_section(board_section_id, body, fields)

Implementation Notes

Update a board section definition.

Response Class

BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}

Parameters

Parameter Required? Description Parameter Type Data Type
board_section_id true Id of board section integer int64
body true Board section body
BoardSection {
can (object, read-only): Operations the current user is able to perform on this object,
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
description (string): Description of the content found in this section.,
board_id (long): Id reference to parent board,
board_items (Array[BoardItem], read-only): Items in the board section,
id (long, read-only): Unique Id,
item_order (Array[long]): ids of the board items in the order they should be displayed,
title (string): Name of row,
updated_at (date-time, read-only): Time at which this section was last updated.
}
BoardItem {
can (object, read-only): Operations the current user is able to perform on this object,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_favorite_id (long, read-only): Content favorite id associated with the item this content is based on,
content_metadata_id (long, read-only): Content metadata id associated with the item this content is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
dashboard_id (long): Dashboard to base this item on,
description (string, read-only): The actual description for display,
favorite_count (long, read-only): Number of times content has been favorited, if present,
board_section_id (long): Associated Board Section,
id (long, read-only): Unique Id,
location (string, read-only): The container folder name of the content,
look_id (long): Look to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
url (string, read-only): Relative url for the associated content,
view_count (long, read-only): Number of times content has been viewed, if present
}
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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete Board section beta

DELETE/api/4.0/board_sections/{board_section_id}
delete_board_section(board_section_id)

Implementation Notes

Delete a board section.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
board_section_id true Id of board section integer int64

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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string
Top