TOOL API

catalog_insight_filter_get

Retrieves available filter values for generating targeted product insights on a limited number of products in an E-commerce catalog. The returned values are intended for use with /catalog/insight/product/get/ to retrieve trending product insights for the catalog. Catalog Product Insights become available 24 hours after you upload at least 20 products to the E-commerce catalog, and insights are refreshed daily at around 4:00 AM UTC.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.catalog_insight_filter_get
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

bc_idrequired

Business Center ID.

catalog_idrequired

Catalog ID. The catalog must be an E-commerce catalog and contain at least 20 products. Obtain valid `catalog_id` values from /catalog/get/ by selecting catalogs with `catalog_type` = `ECOM`. To verify the catalog has at least 20 products, call /catalog/overview/ and confirm the sum of `approved`, `rejected`, and `processing` is 20 or greater.

filter_typerequired

Type of filter values to return. `CATEGORY_ID` returns product category IDs, `BRAND` returns product brand names, and `AVAILABILITY` returns product availability statuses.

page

Current page number. Default is 1. Value must be greater than or equal to 1.

page_size

Number of results to return per page. Default is 10. Valid range is 1-200. `page` and `page_size` can be used to fetch results in smaller batches, but this endpoint does not include pagination information in the response. If you do not need paginated retrieval, set `page_size` to 50 to get the complete result set in a single response.