Get additional interest categories by ID
GET/tool/interest_keyword/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/get/
Description
Use this endpoint to get additional interest categories by ID.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/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 |
|---|---|---|---|---|---|
| keyword_query | query | object[] | No | Information of the additional interest category you want to get. Max size = 50. | |
| filtering | query | object | No | Filtering conditions. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/tool/interest_keyword/get/?keyword_query=%5B%7B%22keyword_id%22%3A%22%22%7D%5D" \ -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/tool/interest_keyword/get/",
params={
"keyword_query": [
{
"keyword_id": ""
}
]
},
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/tool/interest_keyword/get/');
for (const [k, v] of Object.entries({"keyword_query":[{"keyword_id":""}]})) 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/tool/interest_keyword/get/' . '?' . http_build_query(['keyword_query' => '[{"keyword_id":""}]']);
$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 | The return code. For the complete list of error codes and descriptions, see Appendix - Return Codes. | |
| message | string | The return message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Return data. | |
| keywords | object[] | List of additional interest categories. | |
| keyword | string | Additional interest category. | |
| keyword_id | string | Additional interest category ID. | |
| status | string | Whether an additional interest category will be effective. Enum values: `EFFECTIVE`, `INEFFECTIVE`. An additional interest category is effective if using it can reach a reasonable number of people. An additional interest category is ineffective if the projected audience size is too small. Note: Only effective additional interest categories can be used in ad groups to target audiences. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "2021081206012901024503714416ABA90A",
"data": {
"keywords": [
{
"keyword_id": "2027755677",
"status": "EFFECTIVE",
"keyword": "movie app"
}
]
}
}
(/code);
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