Developer resources

Get result details — TikTok Business API

Get result details · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Open in the API index TikTok Business platform page

Get result details

GET/optimizer/rule/result/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/optimizer/rule/result/get/

Description

Use this endpoint to get rule execution results by execution IDs.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/optimizer/rule/result/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
result_detail	query	object[]	Yes		Result details.
lang	query	string	No		Language of the execution results. Enum values: `ZH` (Simplified Chinese), `EN` (English)(default), `JA` (Japanese).

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/optimizer/rule/result/get/?result_detail=%5B%7B%22exec_id%22%3A%22%22%2C%22rule_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/optimizer/rule/result/get/",
    params={
        "result_detail": [
            {
                "exec_id": "",
                "rule_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/optimizer/rule/result/get/');
for (const [k, v] of Object.entries({"result_detail":[{"exec_id":"","rule_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/optimizer/rule/result/get/' . '?' . http_build_query(['result_detail' => '[{"exec_id":"","rule_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	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
message	string	Response message. For details, see Appendix - Return Codes.
request_id	string	Unique ID of the request.
data	object	Returned data.
result_details	object[]	Result details.
rule_id	string	Rule ID.
exec_id	string	Rule execution ID.
action_subject_type	string	Action type. Enum values: `TURN_ON`, `TURN_OFF`, `MESSAGE`.
status	string	Action status. Enum values: `SUCCESS`, `FAIL`
error_message	string	If the action failed, this field returns the error message.
object_dimension	string	Category of the object. Enum values: `CAMPAIGN`, `ADGROUP`, `AD`.
object_dimension_id	string	Object ID.
object_name	string	Object name.

Response sample

{
    "code": 0,
    "message": "OK",
    "request_id": "2021072907015001024501602704097351",
    "data": {
        "result_details": [
            {
                "object_dimension_id": 1695172996977714,
                "rule_id": 6982553361971232769,
                "status": "SUCCESS",
                "object_name": "20210324192339",
                "action_subject_type": "MESSAGE",
                "exec_id": 6983900294136463361,
                "object_dimension": "CAMPAIGN"
            },
            {
                "object_dimension_id": 1695172996977714,
                "rule_id": 6982553361971232769,
                "status": "SUCCESS",
                "object_name": "20210324192339",
                "action_subject_type": "MESSAGE",
                "exec_id": 6983908036217667585,
                "object_dimension": "CAMPAIGN"
            }
        ]
    }
}

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