Get rules by filters — TikTok Business API

Get rules by filters

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/optimizer/rule/list/" \
  -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/optimizer/rule/list/",
    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/optimizer/rule/list/');
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/optimizer/rule/list/' . '?' . 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

{
    "code": 0,
    "message": "OK",
    "request_id": "2021072906564801024501305243095511",
    "data": {
        "rules": [
            {
                "last_check_result_summary": {
                    "change_success": 1,
                    "change_fail": 0,
                    "exec_datetime": "2021-07-12 06:00:00",
                    "task_exec_id": "6983915767100080129",
                    "not_change": 0,
                    "check_datetime": "2021-07-12 06:00:00"
                },
                "rule_id": "6982553361971232769",
                "notification": {
                    "notification_type": "TASK_FINISH"
                },
                "conditions": [
                    {
                        "subject_type": "CLICK",
                        "match_type": "GT",
                        "values": [
                            "0"
                        ],
                        "range_type": "LIFETIME"
                    }
                ],
                "name": "[API]Automated Rule--20210712-PPE-8",
                "rule_exec_info": {
                    "exec_time_type": "PER_HALF_HOUR",
                    "exec_time": ""
                },
                "create_datetime": "2021-07-12 04:43:56",
                "actions": [
                    {
                        "subject_type": "MESSAGE"
                    }
                ],
                "rule_status": "OFF",
                "apply_objects": [
                    {
                        "dimension_ids": [
                            "1695172996977714"
                        ],
                        "pre_condition_type": "SELECTED",
                        "dimension": "CAMPAIGN",
                        "bind_type": "BIND"
                    }
                ]
            },
            {
                "last_check_result_summary": {
                    "change_success": 0,
                    "change_fail": 0,
                    "exec_datetime": "0001-01-01 00:00:00",
                    "task_exec_id": "0",
                    "not_change": 0,
                    "check_datetime": "0001-01-01 00:00:00"
                },
                "rule_id": "6984697088064290818",
                "notification": {
                    "notification_type": "TASK_FINISH"
                },
                "conditions": [
                    {
                        "subject_type": "CLICK",
                        "match_type": "GT",
                        "values": [
                            "1"
                        ],
                        "range_type": "LIFETIME"
                    }
                ],
                "name": "[API]Automated Rule--example-update",
                "rule_exec_info": {
                    "exec_time_type": "PER_HALF_HOUR",
                    "exec_time": ""
                },
                "create_datetime": "2021-07-29 06:45:04",
                "actions": [
                    {
                        "subject_type": "MESSAGE"
                    }
                ],
                "rule_status": "ON",
                "apply_objects": [
                    {
                        "dimension_ids": [
                            "1694011873852465"
                        ],
                        "pre_condition_type": "SELECTED",
                        "dimension": "CAMPAIGN",
                        "bind_type": "BIND"
                    }
                ]
            }
        ]
    }
}

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