User Guide Getting Started Help Center Documentation Community Training
  
English
日本語
Homepage : Manage Homepage

Get All Homepage Items beta

GET/api/3.0/homepage_items
all_homepage_items(fields, sorts, homepage_section_id)

Implementation Notes

Get information about all homepage 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
homepage_section_id false Filter to a specific homepage 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 Homepage Item beta

POST/api/3.0/homepage_items
create_homepage_item(body, fields)

Implementation Notes

Create a new homepage item.

Response Class

HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Homepage Item body
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Get Homepage Item beta

GET/api/3.0/homepage_items/{homepage_item_id}
homepage_item(homepage_item_id, fields)

Implementation Notes

Get information about a homepage item.

Response Class

HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_item_id true Id of homepage 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 Homepage Item beta

PATCH/api/3.0/homepage_items/{homepage_item_id}
update_homepage_item(homepage_item_id, body, fields)

Implementation Notes

Update a homepage item definition.

Response Class

HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_item_id true Id of homepage item integer int64
body true Homepage Item body
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Delete Homepage Item beta

DELETE/api/3.0/homepage_items/{homepage_item_id}
delete_homepage_item(homepage_item_id)

Implementation Notes

Delete a homepage item.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_item_id true Id of homepage_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
}
204 Successfully deleted. string

Get All Homepage sections beta

GET/api/3.0/homepage_sections
all_homepage_sections(fields, sorts)

Implementation Notes

Get information about all homepage 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 Homepage section beta

POST/api/3.0/homepage_sections
create_homepage_section(body, fields)

Implementation Notes

Create a new homepage section.

Response Class

HomepageSection {
id (string, read-only): Unique Id,
title (string): Name of row,
is_header (boolean, read-only): Is this a header section (has no items),
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
created_at (date-time, read-only): Time at which this section was created.,
updated_at (date-time, read-only): Time at which this section was last updated.,
deleted_at (date-time): Time at which this section was deleted.,
homepage_id (long, read-only): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
item_order (Array[long]): ids of the homepage items in the order they should be displayed,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body false Homepage section body
HomepageSection {
id (string, read-only): Unique Id,
title (string): Name of row,
is_header (boolean, read-only): Is this a header section (has no items),
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
created_at (date-time, read-only): Time at which this section was created.,
updated_at (date-time, read-only): Time at which this section was last updated.,
deleted_at (date-time): Time at which this section was deleted.,
homepage_id (long, read-only): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
item_order (Array[long]): ids of the homepage items in the order they should be displayed,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Get Homepage section beta

GET/api/3.0/homepage_sections/{homepage_section_id}
homepage_section(homepage_section_id, fields)

Implementation Notes

Get information about a homepage section.

Response Class

HomepageSection {
id (string, read-only): Unique Id,
title (string): Name of row,
is_header (boolean, read-only): Is this a header section (has no items),
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
created_at (date-time, read-only): Time at which this section was created.,
updated_at (date-time, read-only): Time at which this section was last updated.,
deleted_at (date-time): Time at which this section was deleted.,
homepage_id (long, read-only): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
item_order (Array[long]): ids of the homepage items in the order they should be displayed,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_section_id true Id of homepage 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 Homepage section beta

PATCH/api/3.0/homepage_sections/{homepage_section_id}
update_homepage_section(homepage_section_id, body, fields)

Implementation Notes

Update a homepage section definition.

Response Class

HomepageSection {
id (string, read-only): Unique Id,
title (string): Name of row,
is_header (boolean, read-only): Is this a header section (has no items),
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
created_at (date-time, read-only): Time at which this section was created.,
updated_at (date-time, read-only): Time at which this section was last updated.,
deleted_at (date-time): Time at which this section was deleted.,
homepage_id (long, read-only): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
item_order (Array[long]): ids of the homepage items in the order they should be displayed,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_section_id true Id of homepage section integer int64
body true Homepage section body
HomepageSection {
id (string, read-only): Unique Id,
title (string): Name of row,
is_header (boolean, read-only): Is this a header section (has no items),
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
created_at (date-time, read-only): Time at which this section was created.,
updated_at (date-time, read-only): Time at which this section was last updated.,
deleted_at (date-time): Time at which this section was deleted.,
homepage_id (long, read-only): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
item_order (Array[long]): ids of the homepage items in the order they should be displayed,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
id (string, read-only): Unique Id,
homepage_section_id (string): Associated Homepage Section,
order (long): An arbitrary integer representing the sort order within the section,
title (string, read-only): The actual title for display,
custom_title (string): Custom title entered by the user, if present,
use_custom_title (boolean): Whether the custom title should be used instead of the content title, if the item is associated with content,
description (string, read-only): The actual description for display,
custom_description (string): Custom description entered by the user, if present,
use_custom_description (boolean): Whether the custom description should be used instead of the content description, if the item is associated with content,
url (string, read-only): The actual url for display,
custom_url (string): Custom url entered by the user, if present,
use_custom_url (boolean): Whether the custom url should be used instead of the content url, if the item is associated with content,
image_url (string, read-only): The actual image_url for display,
custom_image_url (string, read-only): Custom image_url entered by the user, if present,
custom_image_data_base64 (string): (Write-Only) base64 encoded image data,
use_custom_image (boolean): Whether the custom image should be used instead of the content image, if the item is associated with content,
look_id (long): Look to base this item on,
dashboard_id (long): Dashboard to base this item on,
lookml_dashboard_id (string): LookML Dashboard to base this item on,
view_count (long, read-only): Number of times content has been viewed, if present,
favorite_count (long, read-only): Number of times content has been favorited, if present,
content_created_by (string, read-only): Name of user who created the content this item is based on,
content_updated_at (string, read-only): Last time the content that this item is based on was updated,
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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
can (object, read-only): Operations the current user is able to perform on this object
}
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
}

Delete Homepage section beta

DELETE/api/3.0/homepage_sections/{homepage_section_id}
delete_homepage_section(homepage_section_id)

Implementation Notes

Delete a homepage section.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_section_id true Id of homepage_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
}
204 Successfully deleted. string
Top