Get Search Ads Campaign Health diagnoses — TikTok Business API

Get Search Ads Campaign Health diagnoses

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/tool/diagnosis/search/health/" \
  -H "Authorization: Bearer $KEY"

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/tool/diagnosis/search/health/",
    params={},
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/tool/diagnosis/search/health/');
for (const [k, v] of Object.entries({})) 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
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/tool/diagnosis/search/health/' . '?' . http_build_query([]);
$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)

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "bid_budget": {
            "bid_budget_status": "GOOD",
            "bid_suggestion_status": "GOOD"
        },
        "keyword_relevance": [
            {
                "ad_id": "{{ad_id}}",
                "adgroup_id": "{{adgroup_id}}",
                "irrelevant_keyword_count": 0,
                "keyword_relevance_status": "RELEVANT",
                "relevant_keyword_count": 1,
                "relevant_keywords": [
                    "{{relevant_keyword}}"
                ]
            }
        ],
        "search_health_status": "NEED_IMPROVEMENT",
        "search_volume": {
            "diagnosis_result": "LOW",
            "total_monthly_searches": 52689
        },
        "total_keyword_count": 1,
        "total_relevant_keyword_count": 1
    }
}

Get started

1. Sign up for Partner
2. Enable a data type of the Ads (Marketing API) group on the platform page
3. Create an API key (tick the TikTok Business channel)
4. Call it as in the examples above