Get Custom Conversions associated with an event source — TikTok Business API

Get Custom Conversions associated with an event source

Request

Endpoint

Authentication & shop

Request parameters

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/custom_conversion/list/?event_source_type=&event_source_id=" \
  -H "Authorization: Bearer $KEY"

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/custom_conversion/list/",
    params={
        "event_source_type": "",
        "event_source_id": ""
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/custom_conversion/list/');
for (const [k, v] of Object.entries({"event_source_type":"","event_source_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
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/custom_conversion/list/' . '?' . http_build_query(['event_source_type' => '', 'event_source_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)

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "activity_info": {
                    "activity_status": "WAITING_FOR_ACTIVITY",
                    "total_count": 0
                },
                "create_time": "{{create_time}}",
                "custom_conversion_id": "{{custom_conversion_id}}",
                "description": "{{description}}",
                "event_source_id": "{{event_source_id}}",
                "event_source_type": "PIXEL",
                "name": "{{name}}",
                "optimization_event": "SHOPPING",
                "rules": [
                    {
                        "operator": "NOT_CONTAIN",
                        "parameter": "EVENT_ID",
                        "values": [
                            "{{event_id}}",
                            "{{event_id}}"
                        ]
                    },
                    {
                        "operator": "START_WITH",
                        "parameter": "DESCRIPTION",
                        "values": [
                            "{{description_value}}"
                        ]
                    }
                ],
                "update_time": "{{update_time}}"
            },
            {
                "activity_info": {
                    "activity_status": "NO_RECENT_ACTIVITY",
                    "last_record_time": "{{last_record_time}}",
                    "total_count": 1
                },
                "create_time": "{{create_time}}",
                "custom_conversion_id": "{{custom_conversion_id}}",
                "description": "",
                "event_source_id": "{{event_source_id}}",
                "event_source_type": "PIXEL",
                "name": "{{name}}",
                "optimization_event": "ON_WEB_CART",
                "rules": [
                    {
                        "operator": "CONTAIN",
                        "parameter": "CONTENT_ID",
                        "values": [
                            "{{content_id}}"
                        ]
                    }
                ],
                "update_time": "{{update_time}}"
            },
            ...
            {
                "activity_info": {
                    "activity_status": "ACTIVE",
                    "last_record_time": "{{last_record_time}}",
                    "total_count": 20
                },
                "create_time": "{{create_time}}",
                "custom_conversion_id": "{{custom_conversion_id}}",
                "description": "",
                "event_source_id": "{{event_source_id}}",
                "event_source_type": "PIXEL",
                "name": "{{name}}",
                "optimization_event": "SHOPPING",
                "rules": [
                    {
                        "operator": "CONTAIN",
                        "parameter": "STATUS",
                        "values": [
                            "{{status_value}}"
                        ]
                    }
                ],
                "update_time": "{{update_time}}"
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 1000,
            "total_number": 98,
            "total_page": 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