Web Diagnostics

Web Diagnostics Suite helps you verify web tracking setup, test events in real-time, and troubleshoot common issues by providing details and solutions on how to fix them. Web Diagnostics Suite includes four core features: Overview, Test Events, Diagnostics, and Change Log.


  • Overview: Verify web tracking setup or monitor activity with quick access to web tracking details. Event Status indicates whether a pixel event is 'Active' or if there is 'No recent activity' while Last Received shows when an event was last recorded.

  • Test Events: Test web events in real-time using a live test environment that mimics how your website will show up in the TikTok app. After scanning the QR code (pixel) or sending the test_event payload (Events API), you can verify events are configured and triggered as expected on your website.

  • Diagnostics: Troubleshoot common issues and improve pixel performance by fixing errors and implementing the recommended solutions. Diagnostics can be accessed through the Web Events details page under the 'Diagnostics' tab.

  • Change Log: View any previous changes made to the web tracking connection or configured events. The change log helps with troubleshooting by pinpointing exactly what changes were made, when they were made, and by whom.


How to access the Web Diagnostics Suite

In TikTok Ads Manager, navigate to “Events Manager” by clicking the Assets tab, Event and then Manage Web Events. Select a Pixel or Events API connection to reach the details page which you will see four tabs:

  1. ​Overview

  2. ​Test Events

  3. ​Diagnostics

  4. ​Change Log


Overview

The Overview tab displays high-level web event details to help you verify web tracking setup and monitor activity.


  • Event Type: Type of event you are tracking on your website, like View Content, Add to Cart or Complete Payment.

  • Event Status: Status of the event based on web tracking activity. Active indicates that an event was shared with TikTok in the last 7 days, while No recent activity indicates that an event has not been shared with TikTok in the last 7 days.

  • Event Name: Customize your event name. For example, if you want to track whenever a website visitor clicks a button to submit a review for a product, you might create a custom name for the Click Button event to indicate it was a Product Review. Event Names are optional.

  • Connection Method: Indicator if event is shared via browser or server.

  • ​Preview Events: Number of events generated by previews. Previews occur when events are fired using the Test Events for Pixel or Events API.

  • Attributed Events: Number of events that can be attributed to TikTok ads.

  • ​Total Events: Total number of events shared via the web tracking connection (Pixel, Events API).

  • ​Last Received: Most recent hour TikTok received the event. This can help you verify that web events being shared are being recorded by TikTok.

https://lf16-cognition-tos.ibytedtos.com/obj/cognition-sg-public/thumbnail_fd621a71cdb54a9fbcbb8fe8e2cb3342_jpg.jpg

Deduplication

Event Deduplication is required for advertisers using both TikTok Pixel SDK and Events API to send duplicate copies of events reporting the same conversion on their website. If TikTok recognizes that events overlap, and are duplicate copies of the same conversion, we will keep and enrich (see below) the first event to ensure that no double counting of such events will occur for the purposes of measurement and reporting. All deduplicated events are used to help advertisers measure, optimize and target their ads on TikTok.


To determine if event deduplication is required, please review the following scenarios:

  • ​Deduplication is not required if advertiser is sharing different events separately via browser and server without overlap

For example, AddToCart events shared via Pixel SDK, and CompletePayment events shared via Events API


  • Deduplication is required if advertiser is sharing all events via both browser and server with event overlap.

For example, all CompletePayment events shared via both Pixel SDK and Events API.


How Deduplication Works

To enable deduplication, developers must ensure the following three parameters are included in the event payload via both Pixel SDK and Events API:

  • pixel code

  • ​event (for example, CompletePayment or AddToCart)

  • ​event_id (a unique string chosen by the advertiser).


Following successful event deduplication setup, events from Pixel SDK and Events API sent to the same pixel code, have the same event id and event type, and arrive within 5 minutes of each other, will be deduplicated.

TikTok will keep the first event that arrives and enrich it by merging match keys and parameters from the latter event into the first event.


Please follow TikTok For Business Developers documentation on ways to set up deduplication. 


Deduplication Scenarios

Please refer to the following scenarios when overlap occurs between the following:

Overlapping between Pixel SDK events

We deduplicate browser events with identical event and event_id parameters.


Overlapping between Events API events

We deduplicate server events with identical event and event_id parameters.


Overlapping between Pixel SDK and Events API events

  • ​We deduplicate browser and server events with identical event and event_id parameters arriving within 5 minutes of each other.

  • ​We enrich and merge extra match keys and parameters into the first event if applicable.


Verify Deduplication Setup

Note: This feature is currently in Beta. If you'd like to use this feature, please reach out to your TikTok representative.


https://lf16-cognition-tos.ibytedtos.com/obj/cognition-sg-public/attachment_df4e6e0740714ce1a95ec166a9d5a53a.png

Please navigate to your pixel's detail page to see if your deduplication worked, and how many events have been deduplicated by following these steps:

  1. ​Hover over the event name.

    1. ​The "Browser" metric is the distinct events received only from Pixel SDK.

    2. ​The "Server" metrics is the distinct events received only from Events API.

    3. ​The "Server & Browser" metrics shows the distinct events from both Events API and Pixel SDK after deduplication. If this metrics is too low, please check your deduplication implementation, and make sure the event_id are identical between Pixel SDK and Events API.


Test Events

Under the Test Event tab, enter the landing page URL to generate a QR code and view your website as it will appear to TikTok users in the app. After the landing page is loaded, trigger events based on event rules you have set up. As each event rule is triggered, an event will be recorded and displayed in real-time, along with details associated with the event.

https://lf16-cognition-tos.ibytedtos.com/obj/cognition-sg-public/thumbnail_227fbc12771f45c6b15ed21fcd7d9bdb_jpg.jpg

Diagnostics

Diagnostics helps you identify common setup errors and implement solutions based on recommended actions. Diagnostics can be accessed through the Web Events details page under the Diagnostics tab.


https://lf16-cognition-tos.ibytedtos.com/obj/cognition-sg-public/thumbnail_fdc53de54af84d109720b336fa482115_jpg.jpg

Error Messages and Suggestions

Standard vs Developer Mode vs Events API

Title

Error message

Suggestion

Standard, Developer Mode

New domain "{domain placeholder}" detected

Your pixel recently started sending data from a new domain.

Check where the pixel has been installed and make any updates as needed.

Standard, Developer Mode

Invalid Event Name

The event name for one or more of your events is invalid. This could impact your ad performance.

Go to your source code and update your event(s).

Standard, Developer Mode

Duplicate event in developer and standard mode

One or more events has been triggered through both developer mode and standard mode. This could affect the accuracy of your pixel reporting and impact your ad performance.

Advertisers can install an event in their site using developer mode or standard mode. If they use both, event triggers will be duplicated, and they are advised to remove one of the modes.

Standard, Developer Mode

Missing Event Name

The event name for one or more of your events is missing. This could impact your ad performance.

Go to your source code and include the event name(s).

Standard

Missing Event Rules

The event rule for one or more of your events is missing. This could impact your ad performance.

Update your pixel event setup to include event rules.

Standard

More than one event contains the same event rule.

The same event rule has been used in multiple events. This could impact your ad performance.

Update your event rules so that each event has a unique event rule.

Developer

Invalid Parameters

The parameters for one or more of your events are invalid. This could impact your dynamic product ads.

Go to your source code and update the parameter(s) to the supported format.

Developer

Invalid "{{event}}" email format

The email format for one or more of your events does not match the format supported. This could impact Advanced Matching and your ad performance.

Go to your source code and update the email parameter(s) for the "{{event}}" event to the supported format.

Developer

Invalid "{{event}}" phone number format

The phone number format for one or more of your events does not match the E.164 format. This could impact Advanced Matching and your ad performance.

Go to your source code and update the phone number parameters for the "{{event}}" event to the supported format.

Developer

Invalid "{{event}}" value parameter

The value parameter for one or more of your events is invalid. This could impact the calculation of return on ad spend.

Go to your source code and update the value parameter(s) for the "{{event}}" event to only contain numbers greater than or equal to zero.

Developer

Missing "{{event}}" currency or value parameter

The currency or value parameter for one or more of your events is missing. This could impact your ad performance.

Go to your source code and include the currency or value parameter(s) for the "{{event}}" event.

Developer

Invalid "{{event}}" currency code

The currency code for one or more of your events does not match the currency codes supported. This could impact the calculation of return on ad spend.

Go to your source code and update the currency parameter(s) for the "{{event}}" event to a supported currency code.

Developer

Invalid "{{event}}" content type

The content type for one or more of your events is invalid. Content type must be either "product" or "product_group".

Go to your source code and update the content type.

Developer

Missing advanced matching parameters

The advanced matching parameter (email or phone number) for one or more of your events is missing. This could impact your ad performance.

Check the advanced matching parameters displayed to see which parameter is missing. Go to your source code and include the missing parameter.

Developer, Events API

Invalid URL parameter

The page URL parameter is invalid. URL must begin with http:// or https://

Go to your source code and adjust your page URL parameter.

Developer, Events API

Missing customer information parameter

No customer information detected in the payload.

Go to your source code and add at least one customer information parameter to improve match rate.

Events API

Invalid click ID

The click ID in the payload is invalid.

Go to your source code and check the implementation of your click ID.

Events API

Missing IP address and user agent combination

IP address and user agent must both be sent.

Go to your source code and include both the IP address and user agent in your payload.


Change Log

The change log is a tab located in the Web Events details page within Events Manager. Within the change log, you can adjust the window to any previous time period which will display the folllowing information for each change:

  • Time: A timestamp of when the change occurred

  • Object: T​he name of the object the change applied to

  • Activity Type: General type of change

  • Activity Details: Detailed description of the changes made

  • User: Name under the account of who made the change

https://lf16-cognition-tos.ibytedtos.com/obj/cognition-sg-public/thumbnail_51733a56efcd41e1a0254537a3415ad8_jpg.jpg

Note: For developer mode and Events API, only changes made to settings in Events Manager will display in the change log but changes made to your website code or events will not be reflected.


Pixel Helper 2.0

Pixel Helper 2.0 is a Chrome extension that can help you verify and troubleshoot Pixel or Events API installation as well, by checking for errors and providing implementation recommendations for your website.


Learn more about TikTok Pixel Helper 2.0.


Pixel Helper 2.0 is available now. Download Pixel Helper.


Content