Report a Web Event
POST/pixel/track/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/pixel/track/
Write endpoint — changes data on TikTok Business. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.
Description
Use this endpoint to report a Web Event.
> 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
POST https://partner.quantri360.com/v1/tiktok_business/pixel/track/
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 |
|---|---|---|---|---|---|
| pixel_code | body | string | Yes | Pixel ID that can be found in events manager of the TikTok ads platform. For details, see the "Where to Find pixel_code" section. | |
| event | body | string | Yes | Conversion event name. It can be either a Standard Event or a Custom Event. To find out the supported values for Standard Events, see the the "Event" column in the "Supported web events" section. To report a Custom Event, pass a customized name in this field. | |
| event_id | body | string | No | Any string or hashed ID that can identify a unique event. This is required if you are sending overlapping events from both TikTok Pixel and Events API. Please check the deduplication subsection for details and complete the setup. Some examples are: - RandomNumber - OrderID (for Purchase event) - SessionID_RandomNumber - ExternalID_RandomNumber - BrowserID_RandomNumber | |
| timestamp | body | string | No | Timestamp that the event took place. Timestamp with ISO 8601 format. See ISO_8601. Please note, if timestamp is not provided, the time when TikTok receives the event via the server will be used. | |
| context | body | object | Yes | Required to attribute events to TikTok campaigns. The context object can be removed for testing event fires. For the data fields in this object, see the "context object parameters" section below. | |
| properties | body | object | No | Properties associated with the event. For the data fields in this object, see the "properties object parameters" section below. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/pixel/track/" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"pixel_code":"","event":"","context":""}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/tiktok_business/pixel/track/",
params={},
json={
"pixel_code": "",
"event": "",
"context": ""
},
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/track/');
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: 'POST',
headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({"pixel_code":"","event":"","context":""}),
});
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/track/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"pixel_code":"","event":"","context":""}');
$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 | Sample | 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 | The log id of a request, which uniquely identifies the request. | |
| data | object | Error details. |
Response sample
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"request_id": "2019091810032301011023224213558",
"data":{}
}
(/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