Search Content Views

Version 4.0.24.12

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.

Request

GET /content_view/search
Datatype
Description
Request
HTTP Request
query
HTTP Query
Expand HTTP Query definition...
view_count
string
Match view count
group_id
string
Match Group Id
look_id
string
Match look_id
dashboard_id
string
Match dashboard_id
content_metadata_id
string
Match content metadata id
start_of_week_date
string
Match start of week date (format is "YYYY-MM-DD")
all_time
boolean
True if only all time view records should be returned
user_id
string
Match user id
fields
string
Requested fields
limit
integer
Number of results to return. Use with `offset` to manage pagination of results
offset
integer
Number of results to skip before returning data
sorts
string
Fields to sort by
filter_or
boolean
Combine given search criteria in a boolean OR expression

Response

200: Content View

Datatype
Description
(array)
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
look_id
string
Id of viewed Look
dashboard_id
string
Id of the viewed Dashboard
title
string
Name or title of underlying content
content_metadata_id
string
Content metadata id of the Look or Dashboard
user_id
string
Id of user content was viewed by
group_id
string
Id of group content was viewed by
view_count
integer
Number of times piece of content was viewed
favorite_count
integer
Number of times piece of content was favorited
last_viewed_at
string
Date the piece of content was last viewed
start_of_week_date
string
Week start date for the view and favorite count during that given week

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link