Get filters for catalog product insights
GET/catalog/insight/filter/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/
Description
Use this endpoint to obtain the available filters for generating targeted insights on a limited number of products within an E-commerce catalog.
The returned filter values can be used with /catalog/insight/product/get/ to obtain insights about trending products in your catalog.
>Note
>
- Catalog Product Insights become available 24 hours after you have uploaded a minimum of 20 products to your E-commerce catalog.
- The insights are refreshed daily at around 4:00 AM UTC time.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| bc_id | query | string | Yes | Business Center ID. To obtain the list of Business Centers that you have access to, use /bc/get/. | |
| catalog_id | query | string | Yes | Catalog ID.
The catalog needs to be an E-commerce catalog that contains at least 20 products.
To obtain the list of E-commerce catalogs within a Business Center, use /catalog/get/ and retrieve catalog_id values with catalog_type as ECOM.
To verify that the catalog contains at least 20 products, use /catalog/overview/ and check whether the sum of the values of the returned approved, rejected, and processing fields is equal to or greater than 20. | |
| filter_type | query | string | Yes | The type of filter options.
Enum values:
- CATEGORY_ID: Product category ID.
- BRAND: Product brand name.
- AVAILABILITY: Product availability status. | |
| page | query | integer | No | Current page number. Default value: 1. Value range: ≥ 1. | |
| page_size | query | integer | No | Page size.
Default value: 10. Value range: 1-200.
Note: The page and page_size parameters are provided to allow you to retrieve paginated results in smaller batches, if needed. However, note that this endpoint does not include pagination information in the response.
If you don't want to retrieve paginated results, set page_size to 50 to obtain the complete set of results in a single response. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/?bc_id=&catalog_id=&filter_type=" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/",
params={
"bc_id": "",
"catalog_id": "",
"filter_type": ""
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/');
for (const [k, v] of Object.entries({"bc_id":"","catalog_id":"","filter_type":""})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'GET',
headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());PHP
<?php $key = 'q360_live_...'; // khóa API của brand $url = 'https://partner.quantri360.com/v1/tiktok_business/catalog/insight/filter/get/' . '?' . http_build_query(['bc_id' => '', 'catalog_id' => '', 'filter_type' => '']); $ch = curl_init($url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]); $res = curl_exec($ch); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); echo $status, "\n", $res;
Response
Response fields (as returned by TikTok Business)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix-Return Code. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Returned data. | |
| brands | string[] | Returned only when `filter_type` is set to `BRAND` in the request. The brand names by which you can filter products within the catalog. | |
| availabilities | string[] | Returned only when `filter_type` is set to `AVAILABILITY` in the request. The availability statuses by which you can filter products within the catalog. | |
| categories | object[] | Returned only when `filter_type` is set to `CATEGORY_ID` in the request. Information about the categories by which you can filter products within the catalog. | |
| category_id | string | The TikTok product category ID assigned to the product, consisting of three levels separated by the number sign (#), in the format of `"level_id_1#level_id_2#level_id_3"`. Example: `601152#842248#601302`. | |
| level_info | object | Details of the levels that the category belongs to. | |
| level_id_1 | string | The ID of the level-1 TikTok product category. | |
| level_name_1 | string | The name of the level-1 TikTok product category. | |
| level_id_2 | string | The ID of the level-2 TikTok product category. | |
| level_name_2 | string | The name of the level-2 TikTok product category. | |
| level_id_3 | string | The ID of the level-3 TikTok product category. | |
| level_name_3 | string | The name of the level-3 TikTok product category. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"availabilities": [
"OUT_OF_STOCK",
"IN_STOCK"
]
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above