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

Search Favorite Contents beta

GET/api/3.0/content_favorite/search
search_content_favorites(user_id, limit, offset, sorts, fields)

Implementation Notes

Search Favorite Content.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
user_id false Match User Id integer int64
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

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/3.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,
can (object, read-only): Operations the current user is able to perform on this object
}
LookBasic {
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
content_metadata_id (long, read-only): Id of content metadata,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
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/3.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
}
204 Successfully deleted. string

Create Favorite Content beta

POST/api/3.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,
can (object, read-only): Operations the current user is able to perform on this object
}
LookBasic {
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
content_metadata_id (long, read-only): Id of content metadata,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
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 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,
can (object, read-only): Operations the current user is able to perform on this object
}
LookBasic {
id (long, read-only): Unique Id,
title (string, read-only): Look Title,
content_metadata_id (long, read-only): Id of content metadata,
can (object, read-only): Operations the current user is able to perform on this object
}
DashboardBase {
id (string, read-only): Unique Id,
user_id (long, read-only): Id of User,
title (string, read-only): Dashboard Title,
description (string, read-only): Description,
readonly (boolean, read-only): Is Read-only,
hidden (boolean, read-only): Is Hidden,
refresh_interval (string, read-only): Refresh Interval,
refresh_interval_to_i (long, read-only): Refresh Interval as Integer,
space (SpaceBase, read-only): Space,
model (LookModel, read-only): Model,
content_favorite_id (long, read-only): Content Favorite Id,
scheduled_plan (ScheduledPlan, read-only): ScheduledPlan,
content_metadata_id (long, read-only): Id of content metadata,
query_timezone (string, read-only): Timezone in which the Dashboard will run by default.,
can (object, read-only): Operations the current user is able to perform on this object
}
SpaceBase {
id (string, read-only): Unique Id,
content_metadata_id (long, read-only): Id of content metadata,
creator_id (long, read-only): User Id of Creator,
name (string, read-only): Unique Name,
parent_id (long, required): Id of Parent,
is_personal (boolean, read-only): Space is a user's personal space,
is_personal_descendant (boolean, read-only): Space is descendant of a user's personal space,
is_shared_root (boolean, read-only): Space is the root shared space,
is_users_root (boolean, read-only): Space is the root user space,
is_root (boolean, read-only): (DEPRECATED) Space is the root shared space (alias of is_shared_root),
is_user_root (boolean, read-only): (DEPRECATED) Space is the root user space (alias of is_users_root,
is_embed (boolean, read-only): Space is an embed space,
is_embed_shared_root (boolean, read-only): Space is the root embed shared space,
is_embed_users_root (boolean, read-only): Space is the root embed users space,
external_id (string, read-only): Embedder's Id if this space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
child_count (long, read-only): Children Count,
can (object, read-only): Operations the current user is able to perform on this object
}
LookModel {
id (string, read-only): Model Id,
label (string, read-only): Model Label,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlan {
id (long, read-only): Unique Id,
name (string): Name,
created_at (date-time, read-only): Date and time when ScheduledPlan was created,
updated_at (date-time, read-only): Date and time when ScheduledPlan was last updated,
title (string, read-only): Title,
user_id (long): User Id which owns this ScheduledPlan,
user (UserPublic, read-only): User who owns this ScheduledPlan,
run_as_recipient (boolean): Whether schedule is ran as recipient (only applicable for email recipients),
enabled (boolean): Whether the ScheduledPlan is enabled,
next_run_at (date-time, read-only): When the ScheduledPlan will next run (null if running once),
last_run_at (date-time, read-only): When the ScheduledPlan was last run,
look_id (long): Id of a look,
dashboard_id (long): Id of a dashboard,
lookml_dashboard_id (string): Id of a LookML dashboard,
filters_string (string): Query string to run look or dashboard with,
dashboard_filters (string): (DEPRECATED) Alias for filters_string field,
require_results (boolean): Delivery should occur if running the dashboard or look returns results,
require_no_results (boolean): Delivery should occur if the dashboard look does not return results,
require_change (boolean): Delivery should occur if data have changed since the last run,
send_all_results (boolean): Will run an unlimited query and send all results.,
crontab (string): Vixie-Style crontab specification when to run,
datagroup (string): Name of a datagroup; if specified will run when datagroup triggered (can't be used with cron string),
timezone (string): Timezone for interpreting the specified crontab (default is Looker instance timezone),
query_id (string): Query id,
scheduled_plan_destination (Array[ScheduledPlanDestination]): Scheduled plan destinations,
run_once (boolean): Whether the plan in question should only be run once (usually for testing),
include_links (boolean): Whether links back to Looker should be included in this ScheduledPlan,
pdf_paper_size (string): The size of paper a PDF should be rendered for,
pdf_landscape (boolean): Whether the paper should be landscape,
embed (boolean): Whether this schedule is in an embed context or not,
color_theme (string): Color scheme of the dashboard if applicable,
long_tables (boolean): Whether or not to expand table vis to full length,
can (object, read-only): Operations the current user is able to perform on this object
}
UserPublic {
id (long, read-only): Unique Id,
first_name (string, read-only): First Name,
last_name (string, read-only): Last Name,
display_name (string, read-only): Full name for display (available only if both first_name and last_name are set),
avatar_url (string, read-only): URL for the avatar image (may be generic),
url (string, read-only): Link to get this item,
can (object, read-only): Operations the current user is able to perform on this object
}
ScheduledPlanDestination {
id (long, read-only): Unique Id,
scheduled_plan_id (long): Id of a scheduled plan you own,
format (string): The data format to send to the given destination. Supported formats vary by destination, but include: "txt", "csv", "inline_json", "json", "json_detail", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png",
apply_formatting (boolean): Are values formatted? (containing currency symbols, digit separators, etc.,
apply_vis (boolean): Whether visualization options are applied to the results.,
address (string): Address for recipient. For email e.g. 'user@example.com'. For webhooks e.g. 'https://domain/path'. For Amazon S3 e.g. 's3://bucket-name/path/'. For SFTP e.g. 'sftp://host-name/path/'. ,
looker_recipient (boolean, read-only): Whether the recipient is a Looker user on the current instance (only applicable for email recipients),
type (string): Type of the address ('email', 'webhook', 's3', or 'sftp'),
parameters (string): JSON object containing parameters for external scheduling. For Amazon S3, this requires keys and values for access_key_id and region. For SFTP, this requires a key and value for username.,
secret_parameters (string): (Write-Only) JSON object containing secret parameters for external scheduling. For Amazon S3, this requires a key and value for secret_access_key. For SFTP, this requires a key and value for password.,
message (string): Optional message to be included in scheduled emails,
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
}

Get All Content Metadatas beta

GET/api/3.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/3.0/content_metadata/{content_metadata_id}
update_content_metadata(content_metadata_id, body)

Implementation Notes

Move a piece of content.

Response Class

ContentMeta {
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,
space_id (string, read-only): Id of associated space when content_type is "space",
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",
content_type (string, read-only): Content Type ("dashboard", "look", or "space"),
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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_id true Id of content metadata integer int64
body true Content Metadata body
ContentMeta {
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,
space_id (string, read-only): Id of associated space when content_type is "space",
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",
content_type (string, read-only): Content Type ("dashboard", "look", or "space"),
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,
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
}
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 Content Metadata beta

GET/api/3.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 {
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,
space_id (string, read-only): Id of associated space when content_type is "space",
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",
content_type (string, read-only): Content Type ("dashboard", "look", or "space"),
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,
can (object, read-only): Operations the current user is able to perform on this object
}

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/3.0/content_metadata_access
create_content_metadata_access(body)

Implementation Notes

Create content metadata access.

Response Class

ContentMetaGroupUser {
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",
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user,
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 Content Metadata Access body
ContentMetaGroupUser {
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",
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user,
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
}

Get All Content Metadata Accesss beta

GET/api/3.0/content_metadata_access
all_content_metadata_accesss(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 false 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/3.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 {
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",
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
content_metadata_access_id true Id of content metadata access integer int64
body true Content Metadata Access body
ContentMetaGroupUser {
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",
group_id (long, read-only): ID of associated group,
user_id (long, read-only): ID of associated user,
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
}
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 Content Metadata Access beta

DELETE/api/3.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
}
204 Successfully deleted. string

Search Content Views beta

GET/api/3.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, limit, offset, sorts, fields)

Implementation Notes

Search Content View.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
view_count false Match view count integer int64
group_id false Match Group Id integer int64
look_id false Match look_id string string
dashboard_id false Match dashboard_id string string
content_metadata_id false Match content metadata id integer int64
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 integer int64
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
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
}
Top