Developer resources

Get Offline Event sets — TikTok Business API

Get Offline Event sets · 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 Offline Event sets

GET/offline/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/offline/get/

Description

Use this endpoint to get a list of Offline Event sets under an advertiser account. You can filter results by Offline Event set ID or name.

> 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/offline/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
event_set_ids	query	string[]	No		A list of Offline Event set IDs that you want to filter the results by. If this field is not passed, all Offline Event sets under the advertiser account will be returned.
name	query	string	No		Offline Event set name that you want to filter the results by. Length limit: 40 characters. If you pass in both `event_set_ids` and `name`, you will get either one result when an event set is matched with the specified name and its ID is one of the specified event set IDs, or zero result when no event set is matched.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/offline/get/" \
  -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/offline/get/",
    params={},
    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/offline/get/');
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

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/offline/get/' . '?' . 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)

Name	Type	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix-Return Code.
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	Returned data.
event_set_list	object[]	The list of matched Offline Event sets under the specified advertiser account.
advertiser_id	string	Advertiser ID.
event_set_id	string	ID of the Offline Event set.
name	string	Name of the Offline Event set.
description	string	Description that you specified for the Offline Event set. Returns `""` if no description has been specified.
auto_tracking	boolean	Whether Auto Tracking is enabled for the Offline Event set.
create_time	string	The time when the Offline Event set was created, in ISO-8601 format. Example: `2023-04-15T00:23:38Z`.
update_time	string	The time when the event set was last updated, in ISO-8601 format. Example: `2023-04-15T00:23:38Z`.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "event_set_list": [
            {
                "name": "{{name}}",
                "advertiser_id": "{{advertiser_id}}",
                "update_time": "2022-12-08T06:50:37Z",
                "create_time": "2022-12-06T08:42:36Z",
                "event_set_id": "{{event_set_id}}",
                "auto_tracking": true,
                "description": "{{description}}"
            },
            {
                "name": "{{name}}",
                "advertiser_id": "{{advertiser_id}}",
                "update_time": "2022-12-07T14:45:07Z",
                "create_time": "2022-12-07T14:45:07Z",
                "event_set_id": "{{event_set_id}}",
                "auto_tracking": true,
                "description": "{{description}}"
            }
        ]
    }
}

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