Developer resources

Get the application log of audiences — TikTok Business API

Get the application log of audiences · 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 the application log of audiences

GET/dmp/custom_audience/apply/log/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/log/

Description

Use this endpoint to get the latest application log of custom audiences. Note that this endpoint will only get the log of apply operation (action_mode = Apply).

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/log/

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
custom_audience_ids	query	string[]	Yes	A list of custom audience IDs. Note The advertiser must be the owner of the `custom_audience_ids`. Otherwise, an error will occur. You can use the `is_creator` field returned in /dmp/custom_audience/list/ and /dmp/custom_audience/get/ to check whether this advertiser is the owner of this audience.
page	query	number	No	Current page number. Default value: 1.
page_size	query	number	No	Page size. Default value: 10.
timezone	query	string	No	The timezone of returned value. For enum values, see Appendix - Time Zone. If not specified, UTC will be used.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/dmp/custom_audience/apply/log/?custom_audience_ids=%5B%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/dmp/custom_audience/apply/log/",
    params={
        "custom_audience_ids": []
    },
    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/dmp/custom_audience/apply/log/');
for (const [k, v] of Object.entries({"custom_audience_ids":[]})) 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/dmp/custom_audience/apply/log/' . '?' . http_build_query(['custom_audience_ids' => '[]']);
$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	The log ID of a request, which uniquely identifies the request.
data	object	Returned Data.
advertiser_id	string	Advertiser ID.
list	list	Array of application data.
audience_id	string	Audience ID.
adgroup_id	string	Ad group ID.
adgroup_name	string	Ad group name.
usage_mode	string	Audience's usage mode in the ad group. Enum values: `Include`, `Exclude`.
editor	string	Operator.
action_timestamp	string	Time when the action took place, in the format of "YYYY-MM-DD HH:MM:SS".
page_info	object	Pagination information.
page	number	Current page number.
page_size	number	Paging size.
total_number	number	Total number of results.
total_page	number	Total pages of results.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "123",
    "data": {
        "advertiser_id": "123",
        "page_info": {
            "total_number": 8,
            "page_size": 10,
            "page": 1,
            "total_page": 1
        },
        "list": [
            {
                "audience_id": "123",
                "adgroup_name": "123",
                "action_timestamp": "2022-06-15 11:31:00",
                "editor": "123",
                "usage_mode": "Include",
                "adgroup_id": "123"
            },
            {
                "audience_id": "123",
                "adgroup_name": "123",
                "action_timestamp": "2023-01-23 22:49:06",
                "editor": "123",
                "usage_mode": "Exclude",
                "adgroup_id": "123"
            }
        ]
    }
}

(/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