VI | EN
Message us on Messenger
Developer resources

Get details of Saved Audiences — TikTok Business API

Get details of Saved 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.

Get details of Saved Audiences

GET/dmp/saved_audience/list/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/dmp/saved_audience/list/
Description

Use this endpoint to get the details of Saved Audiences associated with an ad account.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/dmp/saved_audience/list/

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
saved_audience_idsquerystring[]NoIDs of Saved Audiences. Max size: 100. To create Saved Audiences and obtain the Saved Audience IDs, use /dmp/saved_audience/create/.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/dmp/saved_audience/list/" \
  -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/saved_audience/list/",
    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/dmp/saved_audience/list/');
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/dmp/saved_audience/list/' . '?' . 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)

NameTypeSampleDescription
codenumberReturn code. For the complete list of response codes and descriptions, see Return codes.
messagestringResponse message. For details, see Return codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
saved_audiencesobject[]A list of Saved Audiences.
saved_audience_idstringSaved Audience ID.
saved_audience_namestringSaved Audience name.
location_idsstring[]IDs of the locations that you want to target.
genderstringYour targeted gender. Enum values: `GENDER_FEMALE`,`GENDER_MALE`,`GENDER_UNLIMITED`
age_groupsstring[]Your targeted age groups. For enum values, see Enumeration - Targeting Age Group.
languagesstring[]Codes of the languages that you want to target.
audience_idsstring[]List of audience IDs.
excluded_audience_idsstring[]List of audience IDs to be excluded.
interest_category_idsstring[]Interest classification.
interest_keyword_idsstring[]IDs of interest keywords to target audience.
actionsobject[]A list of action category objects.
action_category_idsstring[]IDs of the action categories (behaviors) or hashtags that you want to target.
action_scenestringWhere you can collect information about user actions. Enum values: `VIDEO_RELATED`, `CREATOR_RELATED`, `HASHTAG_RELATED`.
action_periodnumberThe time period to include actions from. Enum values: `0`, `7`, `15`. If `action_scene` is `CREATOR_RELATED` or `HASHTAG_RELATED`, `0` will be used regardless of the value you pass in. `0` means that there is no definite timeframe to select actions from.
video_user_actionsstring[]Video-related Actions. - If `action_scene` is `VIDEO_RELATED`, the allowed values are: `WATCHED_TO_END`, `LIKED`, `COMMENTED`, `SHARED`. - If `action_scene` is `CREATOR_RELATED`, the allowed values are: `FOLLOWING`, `VIEW_HOMEPAGE`. - If `action_scene` is `HASHTAG_RELATED`, the allowed value is `VIEW_HASHTAG`.
operating_systemsstring[]Device operating systems. Enum values: `ANDROID`, `IOS`. Only one value is allowed.
min_android_versionstringMinimum device Android version. For enum values, see Enumeration - Minimum Android Version.
min_ios_versionstringMinimum iOS version. For enum values, see Enumeration - Minimum iOS Version.
device_model_idsstring[]IDs of the device models.
network_typesstring[]Device connection types. Default: `unlimited`. For enum values, see Enumeration - Connection Type.
carrier_idsstring[]Carriers.
device_price_rangesnumber[]Targeting device price range. 10000 means 1000+. The numbers must be in multiples of 50. Important:The upper limit you set will be added by 50 and the resulting new number will be used as the actual upper limit for device targeting. The actual upper limit is shown in the ad group settings in TikTok Ads Manager. If you set and get the price range of [0, 250], it actually means [0, 300].
page_infoobjectPage information.
pagenumberCurrent page number.
page_sizenumberPaging Size.
total_numbernumberTotal number of results.
total_pagenumberTotal pages.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "saved_audiences": [
            {
                "interest_keyword_ids": [
                    "{{interest_keyword_id}}"
                ],
                "age_groups": [
                    "{{age_group}}"
                ],
                "actions": [
                    {
                        "action_period": 0,
                        "action_category_ids": [
                            "2"
                        ],
                        "video_user_actions": [
                            "FOLLOWING"
                        ],
                        "action_scene": "CREATOR_RELATED"
                    }
                ],
                "languages": [
                    "en"
                ],
                "location_ids": [
                    "6252001",
                    "2077456"
                ],
                "interest_category_ids": [
                    "14",
                    "16"
                ],
                "network_types": [
                    "WIFI"
                ],
                "saved_audience_name": "{{saved_audience_name}}",
                "operating_systems": [
                    "ANDROID"
                ],
                "device_model_ids": [],
                "excluded_audience_ids": [
                    "{{excluded_audience_ids}}",
                    "{{excluded_audience_ids}}"
                ],
                "saved_audience_id": "{{saved_audience_id}}",
                "audience_ids": [
                    "{{audience_ids}}",
                    "{{audience_ids}}"
                ],
                "device_price_ranges": [
                    0,
                    50,
                    100,
                    150,
                    200,
                    250,
                    300,
                    350,
                    400,
                    450,
                    500,
                    550,
                    600,
                    650,
                    700,
                    750,
                    800,
                    850,
                    900,
                    950,
                    1000
                ],
                "carrier_ids": [
                    "{{carrier_id}}"
                ],
                "gender": "GENDER_FEMALE",
                "min_ios_version": "NONE",
                "min_android_version": "10.0"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 10,
            "total_page": 1,
            "total_number": 1
        }
    }
}

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