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

Search Favorite Contents

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

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
user_id false Match user id(s) 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

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
}
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
}
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,
slug (string, read-only): Content Metadata Slug,
preferred_viewer (string, read-only): The preferred route for viewing this dashboard (ie: dashboards or dashboards-next),
space (SpaceBase, read-only): Space
}
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
}
SpaceBase {
name (string, required): Unique Name,
parent_id (string, required): 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 space 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 space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
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,
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),
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

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
}
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

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
}
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
}
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,
slug (string, read-only): Content Metadata Slug,
preferred_viewer (string, read-only): The preferred route for viewing this dashboard (ie: dashboards or dashboards-next),
space (SpaceBase, read-only): Space
}
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
}
SpaceBase {
name (string, required): Unique Name,
parent_id (string, required): 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 space 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 space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
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,
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),
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
}
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
}
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,
slug (string, read-only): Content Metadata Slug,
preferred_viewer (string, read-only): The preferred route for viewing this dashboard (ie: dashboards or dashboards-next),
space (SpaceBase, read-only): Space
}
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
}
SpaceBase {
name (string, required): Unique Name,
parent_id (string, required): 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 space 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 space was autogenerated as an embedding shared space via 'external_group_id' in an SSO embed login,
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,
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),
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

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

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 {
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 "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,
space_id (string, read-only): Id of associated space when content_type is "space"
}

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 "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,
space_id (string, read-only): Id of associated space when content_type is "space"
}

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

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 {
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 "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,
space_id (string, read-only): Id of associated space when content_type is "space"
}

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

POST/api/3.0/content_metadata_access
create_content_metadata_access(body)

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
}

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 Accesss

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

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 {
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 integer int64
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

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
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Search Content Views

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, fields, limit, offset, sorts)

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 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 (format is “YYYY-MM-DD”) 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
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

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