User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Homepage : Manage Homepage

Get All Homepages beta

GET/api/3.1/homepages
all_homepages(fields)

Implementation Notes

Get information about all homepages.

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

POST/api/3.1/homepages
create_homepage(body, fields)

Implementation Notes

Create a new homepage.

Response Class

Homepage {
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of homepage creatopm,
deleted_at (date-time): Date of homepage deletion,
description (string): Description of homepage,
homepage_sections (Array[HomepageSection], read-only): Sections of the homepage,
id (string, read-only): Unique Id,
section_order (Array[long]): ids of the homepage sections in the order they should be displayed,
title (string): Title of homepage,
updated_at (date-time, read-only): Date of last homepage update,
user_id (long, read-only): User id of homepage creator,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 body
Homepage {
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of homepage creatopm,
deleted_at (date-time): Date of homepage deletion,
description (string): Description of homepage,
homepage_sections (Array[HomepageSection], read-only): Sections of the homepage,
id (string, read-only): Unique Id,
section_order (Array[long]): ids of the homepage sections in the order they should be displayed,
title (string): Title of homepage,
updated_at (date-time, read-only): Date of last homepage update,
user_id (long, read-only): User id of homepage creator,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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
}

Search Homepages beta

GET/api/3.1/homepages/search
search_homepages(title, created_at, first_name, last_name, fields, favorited, sorts, page, per_page, offset, limit, filter_or)

Implementation Notes

Search Homepages.

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 homepage title. string string
created_at false Matches the timestamp for when the homepage was created. string string
first_name false The first name of the user who created this homepage. string string
last_name false The last name of the user who created this homepage. string string
fields false Requested fields. string string
favorited false Return favorited homepages when true. boolean boolean
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 Homepage beta

GET/api/3.1/homepages/{homepage_id}
homepage(homepage_id, fields)

Implementation Notes

Get information about a homepage.

Response Class

Homepage {
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of homepage creatopm,
deleted_at (date-time): Date of homepage deletion,
description (string): Description of homepage,
homepage_sections (Array[HomepageSection], read-only): Sections of the homepage,
id (string, read-only): Unique Id,
section_order (Array[long]): ids of the homepage sections in the order they should be displayed,
title (string): Title of homepage,
updated_at (date-time, read-only): Date of last homepage update,
user_id (long, read-only): User id of homepage creator,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

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

PATCH/api/3.1/homepages/{homepage_id}
update_homepage(homepage_id, body, fields)

Implementation Notes

Update a homepage definition.

Response Class

Homepage {
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of homepage creatopm,
deleted_at (date-time): Date of homepage deletion,
description (string): Description of homepage,
homepage_sections (Array[HomepageSection], read-only): Sections of the homepage,
id (string, read-only): Unique Id,
section_order (Array[long]): ids of the homepage sections in the order they should be displayed,
title (string): Title of homepage,
updated_at (date-time, read-only): Date of last homepage update,
user_id (long, read-only): User id of homepage creator,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_id true Id of homepage integer int64
body true Homepage body
Homepage {
content_metadata_id (long, read-only): Id of associated content_metadata record,
created_at (date-time, read-only): Date of homepage creatopm,
deleted_at (date-time): Date of homepage deletion,
description (string): Description of homepage,
homepage_sections (Array[HomepageSection], read-only): Sections of the homepage,
id (string, read-only): Unique Id,
section_order (Array[long]): ids of the homepage sections in the order they should be displayed,
title (string): Title of homepage,
updated_at (date-time, read-only): Date of last homepage update,
user_id (long, read-only): User id of homepage creator,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 beta

DELETE/api/3.1/homepages/{homepage_id}
delete_homepage(homepage_id)

Implementation Notes

Delete a homepage.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
homepage_id true Id of homepage 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 Items beta

GET/api/3.1/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.1/homepage_items
create_homepage_item(body, fields)

Implementation Notes

Create a new homepage item.

Response Class

HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/homepage_items/{homepage_item_id}
homepage_item(homepage_item_id, fields)

Implementation Notes

Get information about a homepage item.

Response Class

HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/homepage_items/{homepage_item_id}
update_homepage_item(homepage_item_id, body, fields)

Implementation Notes

Update a homepage item definition.

Response Class

HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/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.1/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.1/homepage_sections
create_homepage_section(body, fields)

Implementation Notes

Create a new homepage section.

Response Class

HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/homepage_sections/{homepage_section_id}
homepage_section(homepage_section_id, fields)

Implementation Notes

Get information about a homepage section.

Response Class

HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/homepage_sections/{homepage_section_id}
update_homepage_section(homepage_section_id, body, fields)

Implementation Notes

Update a homepage section definition.

Response Class

HomepageSection {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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 {
created_at (date-time, read-only): Time at which this section was created.,
deleted_at (date-time): Time at which this section was deleted.,
detail_url (string, read-only): A URL pointing to a page showing further information about the content in the section.,
homepage_id (long): Id reference to parent homepage,
homepage_items (Array[HomepageItem], read-only): Items in the homepage section,
id (string, read-only): Unique Id,
is_header (boolean, read-only): Is this a header section (has no items),
item_order (Array[long]): ids of the homepage 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.,
can (object, read-only): Operations the current user is able to perform on this object
}
HomepageItem {
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,
custom_description (string): Custom description entered by the user, 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,
custom_title (string): Custom title entered by the user, if present,
custom_url (string): Custom url entered by the user, if present,
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,
homepage_section_id (string): Associated Homepage 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 (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,
section_fetch_time (float, read-only): Number of seconds it took to fetch the section this item is in,
title (string, read-only): The actual title for display,
url (string, read-only): The actual url for display,
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_image (boolean): Whether the custom image should be used instead of the content image, 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,
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.1/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