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

Search Favorite Contents beta

GET/api/4.0/content_favorite/search
search_content_favorites(id, user_id, content_metadata_id, dashboard_id, look_id, board_id, limit, offset, sorts, fields, filter_or)

Implementation Notes

Search Favorite Content.

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
id false Match content favorite id(s) integer int64
user_id false Match user id(s).To create a list of multiple ids, use commas as separators string string
content_metadata_id false Match content metadata id(s).To create a list of multiple ids, use commas as separators string string
dashboard_id false Match dashboard id(s).To create a list of multiple ids, use commas as separators string string
look_id false Match look id(s).To create a list of multiple ids, use commas as separators string string
board_id false Match board id(s).To create a list of multiple ids, use commas as separators string string
limit false Number of results to return. (used with offset) integer int64
offset false Number of results to skip before returning any. (used with limit) integer int64
sorts false Fields to sort by. string string
fields false Requested fields. string string
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 Favorite Content beta

GET/api/4.0/content_favorite/{content_favorite_id}
content_favorite(content_favorite_id, fields)

Implementation Notes

Get favorite content by its id.

Response Class

ContentFavorite {
id (long, read-only): Unique Id,
user_id (long): User Id which owns this ContentFavorite,
content_metadata_id (long): Content Metadata Id associated with this ContentFavorite,
look_id (long, read-only): Id of a look,
dashboard_id (long, read-only): Id of a dashboard,
look (LookBasic, read-only): Associated Look,
dashboard (DashboardBase, read-only): Associated Dashboard,
board_id (long, read-only): Id of a board
}
LookBasic {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
user_id (long): User Id
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
FolderBase {
name (string, required): Unique Name,
parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry,
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
external_id (string, read-only): Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login,
is_embed (boolean, read-only): Folder is an embed folder,
is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder,
is_embed_users_root (boolean, read-only): Folder is the root embed users folder,
is_personal (boolean, read-only): Folder is a user's personal folder,
is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder,
is_shared_root (boolean, read-only): Folder is the root shared folder,
is_users_root (boolean, read-only): Folder is the root user folder,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_favorite_id true Id of favorite content 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
}

Delete Favorite Content beta

DELETE/api/4.0/content_favorite/{content_favorite_id}
delete_content_favorite(content_favorite_id)

Implementation Notes

Delete favorite content.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
content_favorite_id true Id of favorite content integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Create Favorite Content beta

POST/api/4.0/content_favorite
create_content_favorite(body)

Implementation Notes

Create favorite content.

Response Class

ContentFavorite {
id (long, read-only): Unique Id,
user_id (long): User Id which owns this ContentFavorite,
content_metadata_id (long): Content Metadata Id associated with this ContentFavorite,
look_id (long, read-only): Id of a look,
dashboard_id (long, read-only): Id of a dashboard,
look (LookBasic, read-only): Associated Look,
dashboard (DashboardBase, read-only): Associated Dashboard,
board_id (long, read-only): Id of a board
}
LookBasic {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
user_id (long): User Id
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
FolderBase {
name (string, required): Unique Name,
parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry,
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
external_id (string, read-only): Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login,
is_embed (boolean, read-only): Folder is an embed folder,
is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder,
is_embed_users_root (boolean, read-only): Folder is the root embed users folder,
is_personal (boolean, read-only): Folder is a user's personal folder,
is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder,
is_shared_root (boolean, read-only): Folder is the root shared folder,
is_users_root (boolean, read-only): Folder is the root user folder,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Favorite Content body
ContentFavorite {
id (long, read-only): Unique Id,
user_id (long): User Id which owns this ContentFavorite,
content_metadata_id (long): Content Metadata Id associated with this ContentFavorite,
look_id (long, read-only): Id of a look,
dashboard_id (long, read-only): Id of a dashboard,
look (LookBasic, read-only): Associated Look,
dashboard (DashboardBase, read-only): Associated Dashboard,
board_id (long, read-only): Id of a board
}
LookBasic {
can (object, read-only): Operations the current user is able to perform on this object,
content_metadata_id (long, read-only): Id of content metadata,
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
user_id (long): User Id
}
DashboardBase {
can (object, read-only): Operations the current user is able to perform on this object,
content_favorite_id (long, read-only): Content Favorite Id,
content_metadata_id (long, read-only): Id of content metadata,
description (string, read-only): Description,
hidden (boolean, read-only): Is Hidden,
id (string, read-only): Unique Id,
model (LookModel, read-only): Model,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
readonly (boolean, read-only): Is Read-only,
refresh_interval (string, read-only): Refresh Interval, as a time duration phrase like "2 hours 30 minutes". A number with no time units will be interpreted as whole seconds.,
refresh_interval_to_i (long, read-only): Refresh Interval in milliseconds,
folder (FolderBase, read-only): Folder,
title (string, read-only): Dashboard Title,
user_id (long, read-only): Id of User
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label
}
FolderBase {
name (string, required): Unique Name,
parent_id (string): Id of Parent. If the parent id is null, this is a root-level entry,
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
created_at (date-time, read-only): Time the folder was created,
creator_id (long, read-only): User Id of Creator,
child_count (long, read-only): Children Count,
external_id (string, read-only): Embedder's Id if this folder was autogenerated as an embedding shared folder via 'external_group_id' in an SSO embed login,
is_embed (boolean, read-only): Folder is an embed folder,
is_embed_shared_root (boolean, read-only): Folder is the root embed shared folder,
is_embed_users_root (boolean, read-only): Folder is the root embed users folder,
is_personal (boolean, read-only): Folder is a user's personal folder,
is_personal_descendant (boolean, read-only): Folder is descendant of a user's personal folder,
is_shared_root (boolean, read-only): Folder is the root shared folder,
is_users_root (boolean, read-only): Folder is the root user folder,
can (object, read-only): Operations the current user is able to perform on this object
}

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get All Content Metadatas beta

GET/api/4.0/content_metadata
all_content_metadatas(parent_id, fields)

Implementation Notes

Get information about all content metadata in a space.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
parent_id true Parent space of content. 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 Content Metadata beta

PATCH/api/4.0/content_metadata/{content_metadata_id}
update_content_metadata(content_metadata_id, body)

Implementation Notes

Move a piece of content.

Response Class

ContentMeta {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): Unique Id,
name (string, read-only): Name or title of underlying content,
parent_id (long, read-only): Id of Parent Content,
dashboard_id (string, read-only): Id of associated dashboard when content_type is "dashboard",
look_id (long, read-only): Id of associated look when content_type is "look",
folder_id (string, read-only): Id of associated folder when content_type is "space",
content_type (string, read-only): Content Type ("dashboard", "look", or "folder"),
inherits (boolean): Whether content inherits its access levels from parent,
inheriting_id (long, read-only): Id of Inherited Content,
slug (string, read-only): Content Slug
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_id true Id of content metadata integer int64
body true Content Metadata body
ContentMeta {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): Unique Id,
name (string, read-only): Name or title of underlying content,
parent_id (long, read-only): Id of Parent Content,
dashboard_id (string, read-only): Id of associated dashboard when content_type is "dashboard",
look_id (long, read-only): Id of associated look when content_type is "look",
folder_id (string, read-only): Id of associated folder when content_type is "space",
content_type (string, read-only): Content Type ("dashboard", "look", or "folder"),
inherits (boolean): Whether content inherits its access levels from parent,
inheriting_id (long, read-only): Id of Inherited Content,
slug (string, read-only): Content Slug
}

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Content Metadata beta

GET/api/4.0/content_metadata/{content_metadata_id}
content_metadata(content_metadata_id, fields)

Implementation Notes

Get information about an individual content metadata record.

Response Class

ContentMeta {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): Unique Id,
name (string, read-only): Name or title of underlying content,
parent_id (long, read-only): Id of Parent Content,
dashboard_id (string, read-only): Id of associated dashboard when content_type is "dashboard",
look_id (long, read-only): Id of associated look when content_type is "look",
folder_id (string, read-only): Id of associated folder when content_type is "space",
content_type (string, read-only): Content Type ("dashboard", "look", or "folder"),
inherits (boolean): Whether content inherits its access levels from parent,
inheriting_id (long, read-only): Id of Inherited Content,
slug (string, read-only): Content Slug
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_id true Id of content metadata 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
}

Create Content Metadata Access beta

POST/api/4.0/content_metadata_access
create_content_metadata_access(body, send_boards_notification_email)

Implementation Notes

Create content metadata access.

Response Class

ContentMetaGroupUser {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
content_metadata_id (string, read-only): Id of associated Content Metadata,
permission_type (string, read-only): Type of permission: "view" or "edit" Valid values are: "view", "edit".,
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Content Metadata Access body
ContentMetaGroupUser {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
content_metadata_id (string, read-only): Id of associated Content Metadata,
permission_type (string, read-only): Type of permission: "view" or "edit" Valid values are: "view", "edit".,
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user
}
send_boards_notification_email false Optionally sends notification email when granting access to a board. 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
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get All Content Metadata Accesses beta

GET/api/4.0/content_metadata_access
all_content_metadata_accesses(content_metadata_id, fields)

Implementation Notes

All content metadata access records for a content metadata item.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_id true Id of content metadata 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 Content Metadata Access beta

PUT/api/4.0/content_metadata_access/{content_metadata_access_id}
update_content_metadata_access(content_metadata_access_id, body)

Implementation Notes

Update type of access for content metadata.

Response Class

ContentMetaGroupUser {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
content_metadata_id (string, read-only): Id of associated Content Metadata,
permission_type (string, read-only): Type of permission: "view" or "edit" Valid values are: "view", "edit".,
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_access_id true Id of content metadata access string string
body true Content Metadata Access body
ContentMetaGroupUser {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
content_metadata_id (string, read-only): Id of associated Content Metadata,
permission_type (string, read-only): Type of permission: "view" or "edit" Valid values are: "view", "edit".,
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user
}

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete Content Metadata Access beta

DELETE/api/4.0/content_metadata_access/{content_metadata_access_id}
delete_content_metadata_access(content_metadata_access_id)

Implementation Notes

Remove content metadata access.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_access_id true Id of content metadata access integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Get Content Thumbnail beta

GET/api/4.0/content_thumbnail/{type}/{resource_id}
content_thumbnail(type, resource_id, reload, format, width, height)

Implementation Notes

Get an image representing the contents of a dashboard or look.

The returned thumbnail is an abstract representation of the contents of a dashbord or look and does not reflect the actual data displayed in the respective visualizations.

Response Class

  string

Parameters

Parameter Required? Description Parameter Type Data Type
type true Either dashboard or look string string
resource_id true ID of the dashboard or look to render string string
reload false Whether or not to refresh the rendered image with the latest content string string
format false A value of png produces a thumbnail in PNG format instead of SVG (default) string string
width false The width of the image if format is supplied integer int64
height false The height of the image if format is supplied 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
}

Validate Content beta

GET/api/4.0/content_validation
content_validation(fields)

Implementation Notes

Validate All Content.

Performs validation of all looks and dashboards Returns a list of errors found as well as metadata about the content validation run.

Response Class

ContentValidation {
content_with_errors (Array[ContentValidatorError], read-only): A list of content errors,
computation_time (float, read-only): Duration of content validation in seconds,
total_looks_validated (long, read-only): The number of looks validated,
total_dashboard_elements_validated (long, read-only): The number of dashboard elements validated,
total_dashboard_filters_validated (long, read-only): The number of dashboard filters validated,
total_scheduled_plans_validated (long, read-only): The number of scheduled plans validated,
total_alerts_validated (long, read-only): The number of alerts validated,
total_explores_validated (long, read-only): The number of explores used across all content validated
}
ContentValidatorError {
look (ContentValidationLook, read-only),
dashboard (ContentValidationDashboard, read-only),
dashboard_element (ContentValidationDashboardElement, read-only),
dashboard_filter (ContentValidationDashboardFilter, read-only),
scheduled_plan (ContentValidationScheduledPlan, read-only),
alert (ContentValidationAlert, read-only),
lookml_dashboard (ContentValidationLookMLDashboard, read-only),
lookml_dashboard_element (ContentValidationLookMLDashboardElement, read-only),
errors (Array[ContentValidationError], read-only): A list of errors found for this piece of content,
id (string, read-only): An id unique to this piece of content for this validation run
}
ContentValidationLook {
id (long, read-only): Unique Id,
title (string): Look Title,
folder (ContentValidationFolder, read-only): Folder of this Look
}
ContentValidationFolder {
name (string, required): Unique Name,
id (string, read-only): Unique Id
}
ContentValidationDashboard {
description (string): Description,
id (string, read-only): Unique Id,
folder (ContentValidationFolder, read-only): Folder,
title (string): Dashboard Title
}
ContentValidationDashboardElement {
body_text (string): Text tile body text,
dashboard_id (string): Id of Dashboard,
id (string, read-only): Unique Id,
look_id (string): Id Of Look,
note_display (string): Note Display,
note_state (string): Note State,
note_text (string): Note Text,
note_text_as_html (string, read-only): Note Text as Html,
query_id (long): Id Of Query,
subtitle_text (string): Text tile subtitle text,
title (string): Title of dashboard element,
title_hidden (boolean): Whether title is hidden,
title_text (string): Text tile title,
type (string): Type
}
ContentValidationDashboardFilter {
id (string, read-only): Unique Id,
dashboard_id (string, read-only): Id of Dashboard,
name (string): Name of filter,
title (string): Title of filter,
type (string): Type of filter: one of date, number, string, or field,
default_value (string): Default value of filter,
model (string): Model of filter (required if type = field),
explore (string): Explore of filter (required if type = field),
dimension (string): Dimension of filter (required if type = field)
}
ContentValidationScheduledPlan {
name (string): Name of this scheduled plan,
look_id (long): Id of a look,
id (long, read-only): Unique Id
}
ContentValidationAlert {
id (long): ID of the alert,
lookml_dashboard_id (string): ID of the LookML dashboard associated with the alert,
lookml_link_id (string): ID of the LookML dashboard element associated with the alert,
custom_title (string): An optional, user-defined title for the alert
}
ContentValidationLookMLDashboard {
id (string, read-only): ID of the LookML Dashboard,
title (string, read-only): Title of the LookML Dashboard,
space_id (string, read-only): ID of Space
}
ContentValidationLookMLDashboardElement {
lookml_link_id (string, read-only): Link ID of the LookML Dashboard Element,
title (string, read-only): Title of the LookML Dashboard Element
}
ContentValidationError {
message (string, read-only): Error message,
field_name (string, read-only): Name of the field involved in the error,
model_name (string, read-only): Name of the model involved in the error,
explore_name (string, read-only): Name of the explore involved in the error,
removable (boolean, read-only): Whether this validation error is removable
}

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
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Search Content Views beta

GET/api/4.0/content_view/search
search_content_views(view_count, group_id, look_id, dashboard_id, content_metadata_id, start_of_week_date, all_time, user_id, fields, limit, offset, sorts, filter_or)

Implementation Notes

Search Content Views.

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
view_count false Match view count string string
group_id false Match Group Id string string
look_id false Match look_id string string
dashboard_id false Match dashboard_id string string
content_metadata_id false Match content metadata id string string
start_of_week_date false Match start of week date string string
all_time false True if only all time view records should be returned boolean boolean
user_id false Match user id string string
fields false Requested fields string string
limit false Number of results to return. Use with `offset` to manage pagination of results integer int64
offset false Number of results to skip before returning data integer int64
sorts false Fields to sort by string string
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 Vector Thumbnail deprecated

GET/api/4.0/vector_thumbnail/{type}/{resource_id}
vector_thumbnail(type, resource_id, reload)

Implementation Notes

Get a vector image representing the contents of a dashboard or look.

DEPRECATED: Use content_thumbnail())

The returned thumbnail is an abstract representation of the contents of a dashbord or look and does not reflect the actual data displayed in the respective visualizations.

Response Class

  string

Parameters

Parameter Required? Description Parameter Type Data Type
type true Either dashboard or look string string
resource_id true ID of the dashboard or look to render string string
reload false Whether or not to refresh the rendered image with the latest content 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
}
Top