VI | EN
Message us on Messenger
Developer resources

Get details of audience overlap — TikTok Business API

Get details of audience overlap · 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 details of audience overlap

GET/audience/insight/overlap/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/audience/insight/overlap/
Description

Use this endpoint to get the details of the audience overlap between the benchmark audience and up to four other TikTok Custom Audience segments.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/audience/insight/overlap/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer 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_idquerystring7000000000000000001Tà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

NameInTypeRequiredSampleDescription
benchmark_custom_audience_idquerystringYesThe ID of the custom audience that you select as the benchmark audience. Note: The audience ID that you input here must be accessible by your advertiser ID. Otherwise, an error will occur.
comparison_custom_audience_idsquerystring[]NoThe IDs of the custom audience that you select as the comparison audience. Max size: 4. Note: The audience IDs that you input here must be accessible by your advertiser ID. Otherwise, an error will occur.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/audience/insight/overlap/?benchmark_custom_audience_id=" \
  -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/audience/insight/overlap/",
    params={
        "benchmark_custom_audience_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/audience/insight/overlap/');
for (const [k, v] of Object.entries({"benchmark_custom_audience_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/audience/insight/overlap/' . '?' . http_build_query(['benchmark_custom_audience_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)

NameTypeSampleDescription
codenumberReturn code, see Appendix-Return Codes.
messagestringReturn message, see Appendix-Return Codes.
request_idstringThe log id of a request, which uniquely identifies the request.
dataobjectReturned Data. Note: Audience sizes fewer than 1,000 will not be displayed.
benchmark_audienceobjectBenchmark audience data.
audience_idstringAudience ID.
audience_namestringAudience name.
audience_sizeintAudience size.
targetable_users_count_rangestringThe size range of users in the custom audience who have been active in the last 30 days and can be targeted.
comparison_audiencesobject[]Comparison audience data. Returned if you have input `comparison_custom_audience_ids` in your request.
audience_idstringAudience ID.
audience_namestringAudience name.
audience_sizeintAudience size.
targetable_users_count_rangestringThe size range of users in the custom audience who have been active in the last 30 days and can be targeted.
benchmark_overlap_ratestringThe base percentage of users from the benchmark audience that are available in the comparison audience.
benchmark_overlap_rate_rangestringThe percentage range of users from the benchmark audience that are available in the comparison audience.
benchmark_overlap_count_rangestringThe size range of users from the benchmark audience that are available in the comparison audience.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "benchmark_audience": {
            "audience_id": "{{audience_id}}",
            "audience_name": "{{audience_name}}",
            "audience_size": 29690526,
            "targetable_users_count_range": "15,428,000-18,857,000"
        },
        "comparison_audiences": [
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 4754,
                "targetable_users_count_range": "1,000-2,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 504,
                "targetable_users_count_range": "1,000-2,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 51090,
                "targetable_users_count_range": "25,000-31,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 19449461,
                "targetable_users_count_range": "12,179,000-14,885,000",
                "benchmark_overlap_rate": "7%",
                "benchmark_overlap_rate_range": "6%-9%",
                "benchmark_overlap_count_range": "1,156,000-1,413,000"
            }
        ]
    }
}'

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above