API Reference

πŸ“Š Analytics Integration Guide

This guide covers how to configure and use all available analytics pixels on the Web2Wave platform, including event mappings, data transmission, and testing recommendations.

πŸ“Š Analytics Pixels Integration Guide

This guide covers how to configure and use all available analytics pixels on the Web2Wave platform, including event mappings, data transmission, and testing recommendations.

🎯 Available Analytics Pixels

The platform supports the following analytics and advertising pixels:

  • Facebook Pixel (Meta Pixel) - For Facebook/Instagram advertising
  • TikTok Pixel - For TikTok advertising campaigns
  • Snapchat Pixel - For Snapchat advertising
  • Pinterest Tag - For Pinterest advertising
  • AppLovin AXON - For mobile advertising attribution
  • Google Analytics & Google Ads - For web analytics and Google advertising

πŸ”§ How to Add Pixels to the Platform

General Setup Process

  1. Navigate to Project Settings β†’ Analytics Tab
  2. Enable the desired pixel by checking the checkbox
  3. Configure required fields (Pixel ID, Access Tokens, etc.)
  4. Test configuration using the "Check token" buttons where available
  5. Save settings - The pixel will automatically load on your pages

Configuration Fields by Platform

PlatformRequired FieldsOptional FieldsServer Events
Facebookβ€’ Pixel ID β€’ Access Tokenβ€’ Test Event Code β€’ Server Events Onlyβœ… Full Support
TikTokβ€’ Pixel ID β€’ Access Tokenβ€’ Server Events Onlyβœ… Full Support
Snapchatβ€’ Pixel IDNone❌ Browser Only
Pinterestβ€’ Tag IDNone❌ Browser Only
AppLovinβ€’ Event KeyNone❌ Browser Only
Googleβ€’ Analytics ID β€’ Tag Manager IDβ€’ AdWords Tag IDβœ… Full Support

Note: Snapchat and Pinterest currently support browser tracking only. Server-side event fields are commented out in the current implementation.


πŸ“ˆ Event Mappings by Platform

Facebook Pixel Events

Internal EventFacebook EventEvent Type
PurchasePurchaseStandard
SubscribeSubscribeStandard
InitiateCheckoutInitiateCheckoutStandard
CompleteRegistrationCompleteRegistrationStandard
AddPaymentInfoAddPaymentInfoStandard
StartTrialStartTrialStandard
PageViewViewContentStandard
Paywall Prices visibleViewContentStandard
Paywall click priceViewContentStandard
Other eventsCustom EventsCustom

Special Features:

  • βœ… Enhanced matching with hashed email and user_id (SHA-256)
  • βœ… Event deduplication using eventID
  • βœ… Facebook Click ID (fbclid) and Browser ID (fbp) tracking
  • βœ… Automatic cookie management (_fbc, _fbp)

TikTok Pixel Events

Internal EventTikTok EventNotes
PurchasePurchaseWith transaction data
SubscribeSubscribeWith subscription data
InitiateCheckoutInitiateCheckoutWith cart data
CompleteRegistrationCompleteRegistrationUser signup
AddPaymentInfoAddPaymentInfoPayment info added
StartTrialStartTrialTrial started
PageViewViewContentPage view
All eventsForwardedAll events sent

Special Features:

  • βœ… Enhanced matching with email and external_id
  • βœ… TikTok Click ID (ttclid) tracking
  • βœ… Automatic user identification
  • βœ… Full event forwarding with currency/value data

Snapchat Pixel Events

Internal EventSnapchat EventNotes
PurchasePURCHASEWith price/currency
SubscribePURCHASESubscription purchase
InitiateCheckoutSTART_CHECKOUTCheckout initiated
CompleteRegistrationSIGN_UPUser registration
AddPaymentInfoADD_BILLINGPayment info
StartTrialPURCHASETrial signup
PageViewPAGE_VIEWPage view
Paywall Prices visibleVIEW_CONTENTContent view
AddToCartADD_TO_CARTCart addition
SearchSEARCHSearch performed

Special Features:

  • βœ… Client deduplication ID (client_dedup_id) prevents duplicate events
  • βœ… Snapchat Click ID (sccid, ScCid) tracking
  • βœ… Enhanced user matching with email
  • βœ… Only sends mapped standard events (filters irrelevant events)

Pinterest Tag Events

Internal EventPinterest EventNotes
PurchasecheckoutWith transaction data
SubscribesignupUser signup
InitiateCheckoutaddtocartCheckout process
CompleteRegistrationsignupUser registration
AddPaymentInfoaddtocartPayment process
StartTrialcheckoutTrial conversion
PageViewpagevisitPage view
Paywall Prices visibleviewcategoryCategory view
AddToCartaddtocartCart addition
SearchsearchSearch performed

Special Features:

  • βœ… Enhanced match with email and external_id
  • βœ… Pinterest Click ID (pinclid) tracking
  • βœ… Automatic email hashing for privacy
  • βœ… Cross-device checkout tracking

AppLovin AXON Events

Internal EventAXON EventCategory
PurchasepurchaseRequired
SubscribepurchaseRequired
InitiateCheckoutbegin_checkoutRequired
CompleteRegistrationsign_upRecommended
AddPaymentInfoadd_payment_infoRecommended
PageViewpage_viewRequired
Paywall Prices visibleview_itemRequired
AddToCartadd_to_cartRequired
SearchsearchRecommended

Special Features:

  • βœ… Rich ecommerce data with items array
  • βœ… Product categorization (item_category_id: 317)
  • βœ… Automatic additional events (land on page_view, add_to_cart on checkout)
  • βœ… Mobile-optimized attribution

Google Analytics Events

Internal EventGoogle EventNotes
PurchasepurchaseEnhanced ecommerce
SubscribeconversionGoal conversion
InitiateCheckoutbegin_checkoutEcommerce funnel
CompleteRegistrationsign_upUser action
AddPaymentInfoadd_payment_infoCheckout step
PageViewpage_viewStandard tracking
Paywall Prices visibleview_itemProduct view

Special Features:

  • βœ… Enhanced ecommerce tracking
  • βœ… Multiple tag support (Analytics + Tag Manager + Ads)
  • βœ… Data Layer and gtag support
  • βœ… Custom send_to targeting

πŸ“Š Data Transmitted with Events

Common Data Sent to All Platforms

{
    user_id: "unique_user_identifier",
    email: "[email protected]", // when available
    value: 29.99, // transaction value
    currency: "USD",
    subscription_id: "sub_123456",
    price_id: "price_123",
    external_price_id: "stripe_price_123",
    quiz_id: "quiz_123",
    paywall_id: "paywall_123",
    app_version: "1.0.0"
}

Platform-Specific Data

Facebook Pixel

{
    eventID: "user123_Purchase", // Deduplication
    fbc: "fb.1.1703123456000.abc123", // Facebook Click ID
    fbp: "fb.1.1703123456000.xyz789", // Facebook Browser ID
    external_id: "hashed_user_id", // SHA-256 hashed
    em: "hashed_email" // SHA-256 hashed email
}

TikTok Pixel

{
    external_id: "user_123",
    email: "[email protected]",
    // Full event properties forwarded
}

Snapchat Pixel

{
    client_dedup_id: "user123_Purchase", // Deduplication
    user_id: "user_123",
    user_email: "[email protected]",
    price: 29.99,
    currency: "USD",
    transaction_id: "subscription_123"
}

Pinterest Tag

{
    external_id: "user_123",
    em: "[email protected]", // Auto-hashed
    value: 29.99,
    currency: "USD",
    order_id: "subscription_123"
}

AppLovin AXON

{
    items: [{
        item_id: "price_123",
        item_name: "Subscription",
        quantity: 1,
        price: 29.99,
        currency: "USD",
        item_category_id: 317
    }],
    value: 29.99,
    currency: "USD",
    transaction_id: "subscription_123"
}

Notes:

  • The function is executed per system. Returning false blocks sending only for that specific system.
  • If the function throws an error, the event will be sent (errors are swallowed to avoid losing analytics).
  • Keep logic simple and fast; the function runs for every event.

πŸ” Testing Pixels with Browser Extensions

Facebook Pixel Helper

  • Extension: Facebook Pixel Helper
  • Features: Real-time event monitoring, error detection, parameter validation
  • Testing: Shows all fired events, parameters, and errors
  • What to Check: Event names, parameters, enhanced matching data
  • Recommendation: ⭐⭐⭐⭐⭐ Essential for Facebook debugging

TikTok Pixel Helper

  • Extension: TikTok Pixel Helper
  • Features: Event tracking, parameter validation, data quality monitoring
  • Testing: Monitors TikTok events and enhanced matching
  • What to Check: Event firing, user identification, currency data
  • Recommendation: ⭐⭐⭐⭐ Very useful for TikTok campaigns

Snapchat Pixel Helper

  • Extension: Snap Pixel Helper
  • Features: Event validation, test events, deduplication monitoring
  • Testing: Real-time Snapchat event monitoring
  • What to Check: Event mapping, deduplication IDs, user matching
  • Recommendation: ⭐⭐⭐⭐ Important for Snapchat attribution

Pinterest Tag Helper

  • Extension: Pinterest Tag Helper
  • Features: Tag verification, event tracking, enhanced match validation
  • Testing: Monitors Pinterest events and data quality
  • What to Check: Event firing, enhanced match data, conversion tracking
  • Recommendation: ⭐⭐⭐ Useful for Pinterest campaigns

Google Tag Assistant

  • Extension: Google Tag Assistant
  • Features: Google Analytics, GTM, Google Ads tracking validation
  • Testing: Comprehensive Google ecosystem debugging
  • What to Check: Enhanced ecommerce, goal tracking, conversion data
  • Recommendation: ⭐⭐⭐⭐⭐ Essential for Google properties

Generic Analytics Debuggers

  • Extension: Analytics Debugger
  • Features: Multi-platform analytics debugging
  • Testing: Supports multiple analytics platforms simultaneously
  • What to Check: Cross-platform event consistency
  • Recommendation: ⭐⭐⭐ Good for cross-platform testing

πŸ› οΈ Advanced Configuration

Server-Side Events

Currently supported platforms for server-side events:

  • Facebook: βœ… Full server events support with Conversions API
  • TikTok: βœ… Full server events support with Events API
  • Google: βœ… Enhanced conversions and server-side tracking
  • Snapchat: ❌ Browser-only (server configuration hidden)
  • Pinterest: ❌ Browser-only (server configuration hidden)
  • AppLovin: ❌ Browser-only (no server events available)

To Enable: Check "Use [Platform] for server events only" (where available)

Click ID Parameters

The platform automatically tracks and forwards click IDs:

PlatformClick ID ParameterCookie CreatedPurpose
Facebookfbclid_fbcAttribution tracking
TikTokttclid_ttpCampaign attribution
Snapchatsccid, ScCidNoneClick tracking
PinterestpinclidPlatform-managedAttribution
Googlegclid, gbraidPlatform-managedAds attribution

Enhanced Matching Configuration

Platforms that support enhanced matching automatically use:

  • Email addresses (hashed when required)
  • User IDs as external identifiers
  • Phone numbers (when available)
  • First-party data for better attribution

Event filter function (per system)

You can define an optional JavaScript filter function for each analytics system. If the function returns exactly false for a given event, the event will NOT be sent to that system. Any other return value (or no return) will allow the event to be sent.

How to configure

In the admin UI (Project β†’ Analytics tab), each supported system includes a field named β€œEvent filter function (JS)”. Paste a function into that field. Two formats are supported:

Sample function:

function(event_name, event_properties){ 
  if (event_name.indexOf('Step') > -1) {
    // to skip sending events - return 'false'
    return false; 
  } 
}