Content consumption is aided by a variety of powerful filters and sorts that can be applied. Parsed json should be sent in as a parameter to either the "filters" key or the "sort" key.
Filters
Return only media that matches a set of filters. Filters apply collectively as intersecting clauses.
min_instagram_followers (string) - Submitters with a minimum of instagram followers. Does not affect media from other sources.
min_twitter_followers (string) - Submitters with a minimum of twitter followers. Does not affect media from other sources.
denied_photos (boolean) - Media that has been denied from inbox.
starred_photos (boolean) - Media that has been favorited.
deleted_photos (boolean) - Media that has been deleted from an album.
flagged_photos (boolean) - Media that has been flagged. Note: false is equivalent to null for this filter.
has_permission (boolean) - Media that has been marked as permissioned. Note: false is equivalent to null for this filter.
has_product (boolean) - Media that has been tagged with a product.
in_stock_only (boolean) - Media that has been tagged with at least one product marked in stock. Note: false is equivalent to null for this filter.
content_source (array of strings) - Media from a list of sources ("instagram", "instagram_story", "instagram_feed", "instagram_reel", "twitter", "facebook", "desktop", "youtube", "twitch", "tiktok"). i.e. ["instagram", "twitter"]. SPECIAL NOTE: if "instagram" is included, one or both of the following strings must also be included: "instagram_feed", representing normal instagram content, and "instagram_story", representing story content.
content_type (array of strings) - Select from ["video", "image"]
exclude_connected_user_ids (array of integers) - [12345678, 987654] Exclude content which were uploaded by specific user ids
filter_by_connected_user_ids (array of integers) - [12345678, 987654] Include content which were uploaded by specific user ids
filter_by_subcaption (string) - Media whose captions contain a string. has_permission (boolean) - Media that has been marked as permissioned.
filter_by_userhandle (json) - Include or exclude user content by userhandle (we query userhandles in username and email_address). formatting example: {"contains": ["tonystark"], "not_contains": ["thanos"]}
filter_by_caption(json) - Include or exclude user content by caption (we query captions in title). formatting example: {"contains": ["tonystark"], "not_contains": ["thanos"]}
filter_by_hashtag(json) - Include or exclude user content by hashtag (we query hashtags in title).
- "equals": a string value of a single hashtag to filter by
- "is_one_of": a list of string values, where each value represents a hashtag to filter by. The search results will include any documents that contain at least one of the hashtags in the list.
- "not_equals": a list of string values, where each value represents a hashtag to exclude from the search results.
You can use any combination of these parameters to filter your search results. If you include multiple parameters, they will be evaluated in the order of "equals" -> "not_equals", "is_one_of".
formatting example:
- To filter search results by a single hashtag: {"equals":"food"}
- To filter search results by a list of hashtags: {"is_one_of":["travel","nature"],"not_equals":["pets"]}
product_sku(json) - Include or exclude user content by product sku.
- "equals": a string value of a single sku to filter by
- "is_one_of": a list of string values, where each value represents a sku to filter by. The search results will include any documents that contain at least one of the sku in the list.
- "not_equals": a list of string values, where each value represents a sku to exclude from the search results.
You can use any combination of these parameters to filter your search results.
formatting example:
- To filter search results by a single sku: {"equals":"food"}
- To filter search results by a list of sku: {"is_one_of":["travel","nature"],"not_equals":["pets"]}
in_categories (list of integers) - Include content only in specified category album ids. formatting example: [123, 456, 789]
not_in_categories (list of integers) - Include content NOT found in specified category album ids. formatting example: [123, 456, 789]
has_action_link (boolean) - Media containing an action link.
submitted_date_start (timestamp) - Media which was submitted to its native platform after a unix timestamp.
submitted_date_end (timestamp) - Media which was submitted to its native platform before a unix timestamp.
computer_vision (json) - filtering by computer vision detected elements. formatting example: {"contains": ["denim", "outdoors"]}
vendor_id (string) - An identifier that you have associated with this content
filter_by_language (list of strings) - Include content whose captions are detected to be any of the following languages listed here: https://pypi.org/project/langdetect/ Use the english ISO 639-3 name (e.g. ["english", "chinese"])
album_name (json) - filter by content that has also been tagged in an album of name X. formatting example: {"equals": "Hawaii Influencers"}. Case insensitive.
{
"min_instagram_followers": "10",
"content_source": [
"instagram",
"desktop",
"youtube",
"api",
],
"has_permission": true,
}
Sorts
Sort the media by a parameter. Only one sort can be chosen. Optionally, you can specify descending or ascending. By default, the sort will be ascending.
recency - The date the content submitted to its native platform. If not applicable, the date it was collected into Pixlee.
approved_time - The date the content was approved.
random - Randomized.
pixlee_shares - Number of times the content was shared from a Pixlee widget.
pixlee_likes - Number of likes the content received from a Pixlee widget.
popularity - Popularity of the content on its native platform.
dynamic - Our "secret sauce" -- a special sort that highlights high performance content and updates according to the continued performance of live content.
desc | asc - the sort order.
{
"recency": true,
"desc": true
}