You can also view Looker’s interactive API documentation on the Looker Developer Portal or by using the API Explorer extension.
Get All Boards beta
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
Implementation Notes
Create a new board.
Response Class
BoardSection {
BoardItem {
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 (string, 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 (string, read-only): Unique Id, section_order (Array[string]): 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 (string, 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 (string): Id reference to parent board, board_items (Array[BoardItem], read-only): Items in the board section, id (string, read-only): Unique Id, item_order (Array[string]): ids of the board items in the order they should be displayed, visible_item_order (Array[string], read-only): ids of the homepage items the user can see 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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
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. DEPRECATED. Use offset instead. | integer | int64 |
per_page | false | The number of items in the returned page. DEPRECATED. Use limit instead. | 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
Implementation Notes
Get information about a board.
Response Class
BoardSection {
BoardItem {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_id | true | Id of board | string | string |
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
Implementation Notes
Update a board definition.
Response Class
BoardSection {
BoardItem {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_id | true | Id of board | string | string |
body | true | Board | body |
Board {
can (object, read-only): Operations the current user is able to perform on this object, content_metadata_id (string, 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 (string, read-only): Unique Id, section_order (Array[string]): 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 (string, 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 (string): Id reference to parent board, board_items (Array[BoardItem], read-only): Items in the board section, id (string, read-only): Unique Id, item_order (Array[string]): ids of the board items in the order they should be displayed, visible_item_order (Array[string], read-only): ids of the homepage items the user can see 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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
Implementation Notes
Delete a board.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_id | true | Id of board | 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 }
|
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
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
Implementation Notes
Create a new board item.
Response Class
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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
Implementation Notes
Get information about a board item.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_item_id | true | Id of board item | string | string |
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
Implementation Notes
Update a board item definition.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_item_id | true | Id of board item | string | string |
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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
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 | 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 }
|
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
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
Implementation Notes
Create a new board section.
Response Class
BoardItem {
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 (string): Id reference to parent board, board_items (Array[BoardItem], read-only): Items in the board section, id (string, read-only): Unique Id, item_order (Array[string]): ids of the board items in the order they should be displayed, visible_item_order (Array[string], read-only): ids of the homepage items the user can see 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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
Implementation Notes
Get information about a board section.
Response Class
BoardItem {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_section_id | true | Id of board section | string | string |
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
Implementation Notes
Update a board section definition.
Response Class
BoardItem {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
board_section_id | true | Id of board section | string | string |
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 (string): Id reference to parent board, board_items (Array[BoardItem], read-only): Items in the board section, id (string, read-only): Unique Id, item_order (Array[string]): ids of the board items in the order they should be displayed, visible_item_order (Array[string], read-only): ids of the homepage items the user can see 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 (string, read-only): Content favorite id associated with the item this content is based on, content_metadata_id (string, 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, 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 (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 (string): Associated Board Section, id (string, read-only): Unique Id, image_url (string, read-only): The actual image_url for display, location (string, read-only): 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 (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, 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 (long, read-only): Number of times content has been viewed, if present, custom_image_data_base64 (string): (Write-Only) base64 encoded image data, custom_image_url (string, read-only): 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 }
|
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
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 | 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 }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |