Commanders Act X
Platform XDocumentationWelcome to Success
  • Welcome !
  • Platform updates
    • Announcements
    • Documentation updates
    • Release notes
  • Getting started
    • How the platform works
      • Glossary
        • Condensed platform concepts
    • Platform interface
      • Prod and Testing environments
      • Productivity tools
        • Commander's AI
    • Integrating your data
      • GTM Tutorial
      • OneTag Tutorial
      • Migration guides to the Platform X
        • Migrate from SSv1 to SSv2
          • Send data to serverside v2
            • Purchase event example (ssv1 to ssv2)
        • Migrate from old mobile sdk
  • Features
    • Sources
      • Sources Overview
      • Sources Catalog
        • Web
          • Web container
            • User guides for browser-side platform
              • Container
                • Hosting
                • Creation and modification
                • Generation
                • Testing
                • Deployment and roll back
                • Deletion
                • Statistics
                • Modification history
                • Javascript block
                • Branches
                • Plugin Commanders Act Assistant
              • Tags
                • Add tags
                • Configure tags
                • Rules
                  • Basic actions
                  • Triggers
                  • Perimeters & constraints
              • Data layer and data types
                • External variables
                • Internal variables
                • Event variables
                • Data storage
              • Deduplication
                • Setup guide
                • Setup example
                • Deduplication reports
              • TagPerformance
                • Setup guide
                • Report analysis
                • Troubleshooting
            • Setup guides for developers
              • Web container setup
              • Datalayer setup
              • Browser-side events setup
              • AMP
              • Angular
              • AngularJS
              • React
              • SPA implementation guide
              • VueJS
              • IOT & TV Apps
            • Best Practices
              • FAQ
              • Common Container Strategies
              • Common Trigger Strategies
              • Performance Optimization
              • tC.* attributes and methods
              • APIs
                • Onsite API
              • TMS & Consent banners IDs
          • Javascript SDK
            • Next.js serverside rendering
          • Pixel Tracking API
          • Google Tag Manager (GTM)
          • Shopify
        • Mobile APP
          • Android
          • iOS
          • Flutter
          • React native
        • Advertising
          • Bing Ads (cost import)
          • Facebook Ads (cost import)
          • Criteo (cost import)
          • Realytics
        • Import CRM users
          • API users
          • Users file importer
        • Import conversions
          • API Conversions and Product catalog
          • Conversions files importer
        • Product catalog
          • Product catalog files importer (FTP)
        • Server
          • HTTP tracking API source
            • (deprecated) HTTP tracking API source 1.0
          • Node.JS
          • Python
          • PHP
      • Source Live Event Inspector
      • Source data quality
    • Destinations
      • Destinations overview
        • Automatic Audience replay
      • Destinations catalog
        • AbTasty
        • Actito
        • Adform
        • Adobe
          • Adobe Analytics
          • Adobe Campaign
        • AdRoll
        • Adition
        • Adventori
        • Affilae
        • Alphalyr Marketing Studio
        • Amazon
          • Amazon Ads Conversions API
          • Amazon S3
        • Attraqt
        • Awin
        • Batch Audience
        • Branch Events
        • Button
        • Campaign Analysis Legacy
        • Commission Junction
        • Criteo
          • Criteo - Events
          • Criteo (audiences)
          • Criteo (offline conversions)
        • Data Activation Legacy
        • Dataventure
        • Destination Logs Exporter (closed beta)
        • Dialog-Mail
        • Dynamic Yield
        • Easyence
        • Effinity
        • Eloqua
        • Emarsys
        • Email export
        • Equativ Audience
        • Experian
        • Facebook
          • Facebook Conversions API
            • Facebook CAPI through GTM
            • Performance tab (Event Match Quality)
          • Facebook Custom Audiences
          • Facebook Lead Ads
        • FTP
        • Gamned
        • Google
          • Google Analytics 4
            • Google Analytics 4 - Proxy Mode
          • Google BigQuery
          • Google Conversion Adjustments
          • Google Customer Match
          • Google Display & Video 360
          • Google Enhanced Conversions
          • Google Enhanced Conversions for Leads
          • Google Floodlight Mobile App Conversion
          • Google Search Ads 360 Enhanced Conversions
          • Google Store Sales Direct
        • IBM
        • Inxmail
        • IntelliAd
        • Jellyfish
        • Kameleoon
          • Kameleoon Audience
          • Kameleoon Events
        • Kelkoo
        • Kwanko
        • LinkedIn Conversions API
        • Liveramp
        • Magento
        • Marin Software
        • Mapp
        • Matomo
        • MediaMath
        • Microsoft Advertising Universal Event Tracking
        • Mindlytix
        • Moebel
        • Nextdoor Conversion API
        • OXID
        • Optimizely
        • Outbrain
        • Partnerize
        • Piano Analytics
          • Piano Analytics Collection API
          • Piano Analytics Enrichment API
        • Pinterest
        • Piwik PRO
        • Prediggo
        • Qlik
        • Quantcast
        • Quora Ads Conversion API
        • Rakuten
          • Rakuten Audience
          • Rakuten Events
        • Realytics
        • Reddit Conversions API
        • Responsys
        • RhythmOne
        • Rich Relevance
        • RTB House Audience
        • Salesforce
          • Salesforce Audience Studio
          • Salesforce Marketing Cloud
          • Salesforce Commerce Cloud
        • SAP Commerce Cloud
        • Selligent
        • Skai
        • Smart Adserver
        • SmartFocus
        • Snapchat Conversions API
        • Splio
        • Syte
        • Tableau Online
        • Taboola
          • Taboola Audience
          • Taboola Events
        • Target2sell
        • Temelio
        • Teradata
        • The Trade Desk
          • The Trade Desk Conversions API
          • The Trade Desk Audience
        • TikTok
          • TikTok Events API
          • TikTok Offline Events
        • TimeOne
        • Tradedoubler
        • TradeTracker
        • X (Twitter) Conversion API
        • Xandr
        • Webhook
        • Webtrends
        • ZBO Media
        • Zeta
      • Destination builder
        • Javascript destination builder
          • Tutorial - How to build a server destination with the JS sandbox
          • Serverside javascript helpers
      • Destination filters
      • Mapping and Properties transformation
      • Event delivery
      • Destination event inspector
      • Dry mode (lab)
    • Enrichments
      • Augmented User Attributes
        • Business case
      • Events enrichment
      • Storage Settings
    • Data Quality
      • Event Specification
      • Sources data quality
      • Data cleansing
        • Supported transformation functions - Data cleansing
          • Format a date
    • Identity resolution
      • Migrate from Fuse v1 to Fuse v2
    • Customers
      • Segment
        • Segment overlap
        • Segment stats
    • Explore
      • Campaign analysis
        • Attribution
        • Control Group (Closed Beta )
      • User analysis
        • Dashboards
      • Consent Analysis
    • Consent management
      • Responsability of actors
      • Setup Guides
        • Tag Manager
          • Commanders Act TMS
          • Google Tag Manager (GTM)
          • Google Tag Manager (GTM) - Consent Mode
          • Google Consent Mode in Commanders Act CMP
          • Adobe Launch
        • Websites (Hardcoded)
        • FR : Suppression des cookies lors du retrait du consentement
        • Mobile apps
          • iOS
            • ATT - App Tracking Transparency (iOS 14.5+)
          • Android
      • User Guides
        • Categories & Tags
          • Manage Categories
          • Manage Vendors
          • Assign Categories
        • Privacy Banners
          • Banner Templates
            • Accessibility Template
          • Manage Banner
          • Deploy Banner
          • Copy Banner
        • Consent Analysis
        • Exports
        • Settings
      • Extensions
        • Cookie Scanner
        • Piggybacking
        • Tag Firewall
      • Marketing Preferences Center (additional module)
      • Knowledge Base
        • Consent Object
        • Consent cookies exemption
          • Implementation guide for exempted consent statistics FR market
        • Consent Cookie
        • IAB TCF V2.2 Release details
          • IAB TCF v2.2 CMP requirements
          • IAB TCF v2.2 Migration guide Web
          • IAB TCF v2.2 Migration guide App
        • IAB TCF V2.2 Consent
        • IAB TCF V2.2 and Google FAQ
        • Google ACM requires IAB TCF
        • CCPA & Global Privacy control
      • Rest Data API
        • GET/PUT Consents / preferences
      • OnSite API
        • Getting Started
        • consent.get
        • consent.update
        • consent.revoke
        • consent.onUpdate
        • consent.onReady
        • consentBanner.show
        • consentBanner.hide
        • consentCenter.show
        • consentCenter.hide
      • Platform API
        • Get statistics
  • Use cases
    • Data activation
      • Engage new customers
        • Welcome banner for new customers
        • Real-time promotion for hesitant customers
        • Discount banner for installing the application
        • Personalized ads
        • Engage similar audience (lookalike)
      • Increase loyalty
        • Drive to favourite store
        • Increase Customer Lifetime Value with a loyalty program
        • Notification about order delay
      • Increase revenue
        • Abandoned cart
        • Products recommendations
        • Complementary product offer
      • Retain customers
        • Identify a churn risk with RFM segmentation
        • Identify customers’ preferred channel
        • Contact with the customer support
      • Advocacy
        • Incentive to share customers' experience and rating
        • Sponsorship Program
        • Social Media Hashtag
    • Website performance
    • Consent banners A/B testing
    • Customer analysis
    • Campaigns performance analysis
  • Developers
    • Tracking & Integrations
      • Tracking
        • About events
          • E-commerce/retail events
          • Web event specificity
          • Mobile App event specificity
        • Events reference
          • Common events
          • E-commerce events
          • Video events
          • Campaign Tracking events
        • Properties reference
          • Global properties
          • Video properties
          • Permanent properties
        • Data API
          • HTTP API
          • Segment API
          • User API
          • Product catalog and conversion API
      • Server IP Whitelisting
    • Config API
    • Changelogs
      • Measure.js changelog
      • Web container generator
    • Content Security Policy
  • CONFIGURE
    • Data Management
      • Events collection
      • Data retention duration
      • Data Governance
    • Administration
      • User management
      • Domain Management
        • WAF Proxy (CloudFlare,...)
        • A record
        • CNAME record
        • On-Premise Proxy
        • Cookie CAID
        • First party hosting
      • Single Sign-On
      • Two-factor authentication (2FA)
      • Copy Management
    • Cookies
      • Cookie 1st
      • Cookie sync partners
      • First domain tracking (Phoenix)
    • Disclaimer
Powered by GitBook
On this page
  • Key features
  • Destination setup
  • Configuration
  • Quick reference
  • Field Mappings

Was this helpful?

Edit on GitHub
Export as PDF
  1. Features
  2. Destinations
  3. Destinations catalog
  4. TikTok

TikTok Events API

PreviousTikTokNextTikTok Offline Events

Last updated 8 days ago

Was this helpful?

is a global platform designed to give brands and marketers the solutions to be creative storytellers and meaningfully engage with the TikTok community. The TikTok Events API is a server-side integration that allows you to share website and app visitor events directly with TikTok using their and version 2.0.

The support is currently under beta testing.

Key features

The TikTok Events API destination provides the following key features:

  • Events structure: our matches , meaning that your data is properly bridged to the expected fields in an optimized way.

  • Prebuilt mappings: data mapping for event-based destinations happens automatically, which simplifies user inputs.

  • Automatic hashing: information is automatically hashed matching partner specifications.

  • Smart mapping: data mapping can be readjusted using your datalayer defined fields.

  • Support for multi-item data: information included in the array is dispatched to TikTok.

  • Support for test event code: real-time validation in your test environments with field test_event_code.

Destination setup

Before you get started with this destination, make sure you can access .

TikTok custom events are available for reporting and audience creation purposes. Optimization is currently NOT supported.

Configuration

Settings
Description

Access Token

Pixel Id

App Id

Test Event Code

Event Mapping

TikTok "ViewContent" Event Mapping

Autodiscovery Event Source

Flag this option to set TikTok event_source based on the value provided in the "Smart Mapping" field Experience Type or in the standard property context.app . The "Smart Mapping" field Event Source has priority over this option.

Quick reference

Commanders Act Events
TikTok Events

achieve_level

AchieveLevel [2]

add_payment_info

AddPaymentInfo

add_to_cart

AddToCart

add_to_wishlist

AddToWishlist

application_approval

ApplicationApproval [1]

begin_checkout

InitiateCheckout [1]

click_button

view_content

ViewContent

complete_tutorial

CompleteTutorial [2]

create_group

CreateGroup [2]

create_role

CreateRole [2]

customize_product

CustomizeProduct [1]

purchase

CompletePayment [1][4] Checkout [2]

complete_payment

CompletePayment [1][4] Purchase [2]

contact

Contact [1]

download

Download [1]

find_location

FindLocation [1]

submit_form

generate_lead

Lead [1]

generate_lead

GenerateLead [2]

in_app_ad_click

InAppADClick [2]

in_app_ad_impr

InAppAdImpr [2]

install_app

InstallApp [2]

join_group

JoinGroup [2]

launch_app

LaunchAPP [2]

loan_application

LoanApplication [2]

loan_approval

LoanApproval [2]

loan_disbursal

LoanDisbursal [2]

login

Login [2]

view_content

page_view[3]

view_item[3]

ViewContent

rate

Rate [2]

schedule

Schedule [1]

search

Search

sign_up

CompleteRegistration [1]

Registration [2]

spend_credits

SpendCredits [2]

start_trial

StartTrial

submit_application

SubmitApplication [1]

subscribe

Subscribe

unlock_achievement

UnlockAchievement [2]

Field Mappings

Commanders Act Properties
TikTok Properties

partners.tiktok.event_source

event_source [*][1]

Pixel Id

App Id

event_source_id [*]

event_name

data.0.event [*][2]

context.event_timestamp

data.0.event_time [*][3]

id

data.0.event_id [4]

partners.tiktok.ttclid

data.0.user.ttclid [5]

user.id

data.0.user.external_id [6]

partners.tiktok.ttp

data.0.user.ttp [7]

context.page.url

data.0.page.url

context.page.referrer

data.0.page.referrer

context.device.advertising_id

data.0.user.idfa [8]

context.device.idfv

data.0.user.idfv [8]

context.device.att_status

data.0.user.att_status [8][9]

context.device.advertising_id

data.0.user.gaid [10]

context.app.namespace

data.0.app.app_id [11]

context.app.name

data.0.app.app_name

context.app.version

data.0.app.app_version

user.email

data.0.user.email [6]

user.phone

data.0.user.phone [6][12]

context.device.ip

data.0.user.ip

context.device.user_agent

data.0.user.user_agent

context.device.language

data.0.user.locale [13]

partners.tiktok.ldu

data.0.limited_data_use [14]

items.X.content_type

data.0.properties.contents.X.content_type [15]

items.X.id

data.0.properties.contents.X.content_id

data.0.properties.content_ids [16]

items.X.product.price

data.0.properties.contents.X.price

items.X.quantity

data.0.properties.contents.X.quantity

items.X.product.name

data.0.properties.contents.X.content_name

items.X.product.category_1

data.0.properties.contents.X.content_category

items.X.product.brand

data.0.properties.contents.X.brand

search_term

data.0.properties.search_string [17]

id

data.0.properties.order_id [17]

partners.tiktok.shop_id

data.0.properties.shop_id [17]

status

data.0.properties.status [17]

content_type

data.0.properties.content_type [17]

currency

data.0.properties.currency

event_name

data.0.properties.description

value

data.0.properties.value

items.length

data.0.properties.num_items

Test Event Code

test_event_code

Required for . Your as provided by TikTok. More details are available by following this .

Required for . Your pixel identifier as provided by TikTok. More details are available by following this .

Required for . Your app identifier as provided by TikTok. More details are available by following this .

For only. This is used to test event tracking before deploying in production. This code can be found in the following Assets ➜ Events ➜ Manage (Web Events) ➜ Select your pixel ➜ Test Events (Tab) [1]

Change the standard mapping between TikTok's events and yours or add new mappings: custom events are also supported. More details on how you can set up custom TikTok web events are available following this .

Select page_view, view_item or both to send TikTok ViewContent event. See for more details on event mapping.

[1] The Test Event Code can only be set in test environments as TikTok won't save data coming from live events where this code is included. More details are available following this .

TikTok standard events are detailed in this .

[1] For web events only. See event_source in for more details. [2] For app events only. See event_source in for more details. [3] Depending on your selection for TikTok "ViewContent" Event Mapping . See for more details. [4] With CompletePayment events you can take advantage of TikTok (VBO Web).

Most properties can be remapped using our "Smart Mapping" feature. TikTok client-side pixel saves a unique identifier in cookie , which is used to match website visitor events with TikTok ads. This destination starts by getting this identifier from partners.tiktok.ttp . If it's not present, it looks for the previously mentioned cookie and sets TikTok data.0.user.ttp with the resulting value. The is a tracking parameter that is attached to your ad's landing page URLs. This destination checks if partners.tiktok.ttclid is set with the ttclid value. If it's not present, it looks for cookie ttclid. If none is found it tries by parsing the value from context.page.url .

[*] Mandatory property. [1] Supported values: web , app , offline , and crm . When Autodiscovery Event Source is flagged, if the "Smart Mapping" field Experience Type is set with a property holding the value native app or the object context.app has at least a property then this is set with app . The "Smart Mapping" Event Source has priority over the autodiscovery feature. Default value: web . [2] See for more details on event mapping. [3] If not provided, the current timestamp is used. [4] Required if you are sending web events from both TikTok browser pixel and this destination. Used in deduplication together with event_source_id and data[0].event . More details are available following this . [5] If not provided, the cookie ttclid or context.page.url is used. [6] If provided in clear text, it's automatically hashed with SHA-256. [7] If not provided, the cookie _ttp is used. [8] Set when the "Smart Mapping" property Device Platform or context.device.type is set with iOS (case insensitive). [9] Supported values: AUTHORIZED , DENIED , NOT_DETERMINED , RESTRICTED and NOT_APPLICABLE. More details are available following this . [10] Set when the "Smart Mapping" property Device Platform or context.device.type is set with Android (case insensitive). [11] Required for app events. [12] Phone number in the . [13] See . [14] See for more details. [15] Supported values: product and product_group . Default: product . [16] Required for Video Shopping Ads (VSA). [17] Set for web events.

TikTok for Business
Events API for Web
Events API for App
Events API for APP
Events reference
TikTok's one
item
TikTok Ads Manager
LINK
LINK
_ttp
_ttp
Tiktok Click ID
Value-Based Optimization for Web
Configuration
Configuration
Configuration
LINK
LINK
E.164 format
BCP 47 language identifier
Events API 2.0 - Limited Data Use
Quick reference
Web events
API Access Token
LINK
Web events
LINK
App events
LINK
Web events
TikTok Ads Manager
LINK
Quick reference