Developer resources

Get Instant Page events — TikTok Business API

Get Instant Page events · 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 Instant Page events

GET/pixel/instant_page/event/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/pixel/instant_page/event/

Description

Use this endpoint to get the supported events for Instant Pages based on your objective types and optimization goals.

> Important

> By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms and that you will not share sensitive data with TikTok.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/pixel/instant_page/event/

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	Description
objective_type	query	string	Yes	Objective type. Must be either `CONVERSIONS` or `APP_PROMOTION`.
optimization_goal	query	string	Yes	Optimization goal
is_retargeting	query	boolean	No	Whether it is for retargeting

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/pixel/instant_page/event/?objective_type=&optimization_goal=" \
  -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/pixel/instant_page/event/",
    params={
        "objective_type": "",
        "optimization_goal": ""
    },
    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/pixel/instant_page/event/');
for (const [k, v] of Object.entries({"objective_type":"","optimization_goal":""})) 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/pixel/instant_page/event/' . '?' . http_build_query(['objective_type' => '', 'optimization_goal' => '']);
$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	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.
data	object	Return data
list	object[]	Data list
business_type	string	Business type. Currently, the only supported value is `TIKTOK_INSTANT_PAGE`.
instant_page_events	object	Instant page events
objective_types	object[]	List of objective types
objective_type	string	Objective type. Can be `CONVERSIONS`, `APP_PROMOTION`.
optimization_goals	object[]	List of optimization goals
optimization_goal	string	Optimization goal
optimization_events	string[]	List of external actions. Currently, the only allowed value is `BUTTON`, which means button clicks.
request_id	string	Unique ID of the request

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "LOG_ID",
    "data": {
        "list": [
            {
                "business_type": "TIKTOK_INSTANT_PAGE",
                "instant_page_events": {
                    "objective_types": [
                        {
                            "optimization_goals": [
                                {
                                    "optimization_goal": "CONVERT",
                                    "optimization_events": [
                                        "BUTTON"
                                    ]
                                }
                            ],
                            "objective_type": "CONVERSIONS"
                        }
                    ]
                }
            }
        ]
    }
}
(/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