Run an Upgraded Smart+ Creative Overview Report — TikTok Business API

Run an Upgraded Smart+ Creative Overview Report

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/smart_plus/material_report/overview/?dimensions=%5B%5D" \
  -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/smart_plus/material_report/overview/",
    params={
        "dimensions": []
    },
    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/smart_plus/material_report/overview/');
for (const [k, v] of Object.entries({"dimensions":[]})) 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/smart_plus/material_report/overview/' . '?' . http_build_query(['dimensions' => '[]']);
$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

{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "dimensions": {
                    "main_material_id": "{{main_material_id}}",
                    "main_material_type": "VIDEO_SPARK_ADS",
                    "smart_plus_ad_id": "{{smart_plus_ad_id}}"
                },
                "metrics": {
                    "main_material_name": "{{main_material_name}}",
                    "spend": "0.00"
                }
            },
            {
                "dimensions": {
                    "main_material_id": "{{main_material_id}}",
                    "main_material_type": "CAROUSEL_SPARK_ADS",
                    "smart_plus_ad_id": "{{smart_plus_ad_id}}"
                },
                "metrics": {
                    "main_material_name": "{{main_material_name}}",
                    "spend": "0.00"
                }
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 100,
            "total_number": 2,
            "total_page": 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