Logo
  • E-commerce Attribution
  • Email performance
  • Online Store Performance
  • Paid Performance
  • Subscription Performance
  • Website Performance
  • Shopify
  • Magento
Start free trial
Eyk Docs
Eyk Docs
🔌

Event spec

Server-side tracking

Tracking for ShopifyTracking for ShopifyTracking for Magento 2Tracking for Magento 2Tracking for FirmhouseTracking for Firmhouse🔌Event spec🌐UTM parameter guide

Insights

E-commerce AttributionE-commerce AttributionEmail PerformanceEmail PerformanceOnline Store PerformanceOnline Store PerformancePaid PerformancePaid PerformanceRFM SegmentationRFM SegmentationSubscription PerformanceSubscription PerformanceWebsite PerformanceWebsite Performance

Sources

Amazon Seller PartnerAmazon Seller PartnerBol.comBol.comCopernicaCopernicaFacebook AdsFacebook AdsFirmhouseFirmhouseGoogle AdsGoogle AdsGoogle Analytics 4Google Analytics 4Google Search ConsoleGoogle Search ConsoleKlaviyoKlaviyoLinkedInLinkedInMagento 2Magento 2Microsoft AdvertisingMicrosoft AdvertisingPinterestPinterestShopifyShopify

Destinations

Google Ads conversionGoogle Ads conversionGoogle Analytics 4 Google Analytics 4 Meta AdsMeta AdsTikTok AdsTikTok Ads

How-to guides

🔐Configure SSH access for Magento⚖️Attribution models and how to use them

Eyk event specification

Page load

This event is automatically tracked and does not need to be added to the data layer.

Type: client-side 🌐

View Item

Type: client-side 🌐

View Collection

Type: client-side 🌐

Add to Cart

Type: client-side 🌐

View Cart

Type: client-side 🌐

Begin Checkout

Type: client-side 🌐

Add Payment Info

Type: client-side 🌐

Add Shipping Info

Type: client-side 🌐

Purchase

Type: client-side 🌐

Purchase (webhook)

Type: server-side 🔌

Cookie explanation:

  • __eui: The Eyk User ID
  • _fbc: The Meta (Facebook/Instagram) Click ID
  • _fbp: The Meta (Facebook/Instagram) Browser ID
  • _ga: The Google Analytics Client ID
  • _gcl_aw: The Google Ads Click ID (GCLID)
  • _gcl_au: The Google Marketing Platform Conversion Linker
  • _uetsid: The Microsoft (Bing) Session ID
  • _uetvid: The Microsoft (Bing) Visitor ID
  • ttclid: The TikTok Click ID
  • _ttp: The TikTok Pixel ID
  • _epik: The Pinterest Click ID
  • awin_awc: The Awin Click ID
  • __kla_id: The Klaviyo Identity Cookie

Consent explanation:

This object passes the user's explicit choices regarding data collection, formatted according to Google Consent Mode v2 standards. Accepted values: granted , denied

Subscription Start

Type: client-side 🌐 & server-side 🔌

← Previous

Eyk DocsEyk Docs

Next →

🌐UTM parameter guide

On this page

  • Eyk event specification
  • Page load
  • View Item
  • View Collection
  • Add to Cart
  • View Cart
  • Begin Checkout
  • Add Payment Info
  • Add Shipping Info
  • Purchase
  • Purchase (webhook)
  • Subscription Start
Logo

Login

Start free trial

© Eyk B.V.

LinkedIn
{
    "event": "page_view_eyk",
    "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
    }
}
{
    "event": "view_item_eyk",
    "ecommerce": {
        "currency": "EUR",
        "value": "100",
        "items": [
            {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "100",
               "quantity": "1",
               "variant_name": "Default Title"
           }
        ]
    },
    "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
    }
}

{
    "event": "view_collection_eyk",
    "ecommerce": {
        "collection_id": "12345678",
        "currency": "EUR",
        "item_list_name": "Products",
        "items": [
            {
                "image_url": "https://example-store.com/images/gift-card.png",
                "index": "1",
                "item_brand": "Snowboard Vendor",
                "item_category": "Gifts",
                "item_id": "8404872757547",
                "item_name": "Gift Card",
                "item_sku": "SKU-123478",
                "item_variant": "45556788429099",
                "price": "10.00",
                "variant_name": "$10"
            },
            {
                "image_url": "https://example-store.com/images/ski-wax.png",
                "index": "2",
                "item_brand": "GTM-test-store-10",
                "item_category": "Gifts",
                "item_id": "9143900537115",
                "item_name": "Selling Plans Ski Wax",
                "item_sku": "SKU-1237658",
                "item_variant": "48564641825051",
                "price": "24.95",
                "variant_name": "Selling Plans Ski Wax"
           }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
     }
}
{
    "event": "add_to_cart_eyk",
    "ecommerce": {
        "currency": "EUR",
        "value": "600",
        "items": [
            {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "600",
               "quantity": "1",
               "variant_name": "Default Title"
            }
        ]
    },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
    }
}
{
    "event": "view_cart_eyk",
    "ecommerce": {
         "value": "600",
         "currency": "EUR",
         "cart_quantity": "1",
         "items": [
             {
                "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
                "item_brand": "Hydrogen Vendor",
                "item_category": "Gifts",
                "item_id": "9143899914523",
                "item_name": "The Collection Snowboard: Hydrogen",
                "item_sku": "SKU-76543281",
                "item_variant": "485646409345615",
                "price": "600",
                "quantity": "1",
                "variant_name": "Default Title"
             }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
    }
}
{
    "event": "begin_checkout_eyk",
    "ecommerce": {
        "value": "600",
        "currency": "EUR",
        "cart_quantity": "1",
        "items": [
            {
              "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
              "item_brand": "Hydrogen Vendor",
              "item_category": "Gifts",
              "item_id": "9143899914523",
              "item_name": "The Collection Snowboard: Hydrogen",
              "item_sku": "SKU-76543281",
              "item_variant": "485646409345615",
              "price": "600",
              "quantity": "1",
              "variant_name": "Default Title"
            }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
     }
}
{
    "event": "add_payment_info_eyk",
    "ecommerce": {
         "value": "600",
         "currency": "EUR",
         "cart_quantity": "1",
         "payment_type": "iDeal",
         "items": [
             {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "600",
               "quantity": "1",
               "variant_name": "Default Title"
             }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
     }
}
{
    "event": "add_shipping_info_eyk",
    "ecommerce": {
         "value": "600",
         "currency": "EUR",
         "cart_quantity": "1",
         "items": [
             {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "600",
               "quantity": "1",
               "variant_name": "Default Title"
             }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK"
     }
}
{
    "event": "purchase_eyk",
    "ecommerce": {
        "cart_quantity": "1",
        "value": "600",
        "coupon": "test",
        "currency": "EUR",
        "discount": "test",
        "discount_amount": "90.00",
        "discount_percentage": "15",
        "shipping": "0",
        "sub_total": "510",
        "tax": "0",
        "transaction_id": "5937102258459",
        "items": [
            {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "600",
               "quantity": "1",
               "variant_name": "Default Title"
             }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK",
        "new_customer": true
     }
}
{
    "event": "purchase_webhook_eyk",
    "ecommerce": {
        "cart_quantity": "1",
        "value": "600",
        "coupon": "test",
        "currency": "EUR",
        "discount": "test",
        "discount_amount": "90.00",
        "discount_percentage": "15",
        "shipping": "0",
        "sub_total": "510",
        "tax": "0",
        "transaction_id": "5937102258459",
        "items": [
            {
               "image_url": "https://example-store.com/images/snowboard-hydrogen.png",
               "item_brand": "Hydrogen Vendor",
               "item_category": "Gifts",
               "item_id": "9143899914523",
               "item_name": "The Collection Snowboard: Hydrogen",
               "item_sku": "SKU-76543281",
               "item_variant": "485646409345615",
               "price": "600",
               "quantity": "1",
               "variant_name": "Default Title"
             }
         ]
     },
     "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK",
        "new_customer": true
     },
     "cookies": {
        "__eui": "28e7e120-d123-4567-8910...",
        "_fbc": "fb.1.1707923456.IwAR0...",
        "_fbp": "fb.1.1707923456.1234567...",
        "_ga": "GA1.1.123456789.1707923...",
        "_gcl_aw": "GCL.1707923456.IwAR0_Q...",
        "_gcl_au": "1.1.1234567890.1707923...",
        "_uetsid": "28e7e120-d123-4567-8910...",
        "_uetvid": "48b6c450-a123-4567-8910...",
        "_epik": "dj0yJnU9UmFuZG9tUGludGVy...",
        "_ttp": "a1b2c3d4-e5f6-7890-g1h2...",
        "ttclid": "E.C.P.dje8a90d...",
        "awin_awc": "12345_1707923456_a1b2c3d...",
        "__kla_id": "eyIkZXhjaGFuZ2VfaWQiOiAiS...",
        "_kx": "eyIkZXhjaGFuZ2VfaWQiOiAiS..."
     },
     "consent": {
        "ad_storage": "granted",
        "analytics_storage": "granted",
        "ad_user_data": "granted",
        "ad_personalization": "granted"
     }
}
{
    "event": "subscription_start_eyk",
    "ecommerce": {
        "currency": "EUR",
        "value": "100",
        "items": [
            {
               "image_url": "https://example-store.com/images/subscription-product.png",
               "item_brand": "Subscription Vendor",
               "item_category": "Subscriptions",
               "item_id": "9143899914524",
               "item_name": "Monthly Subscription",
               "item_sku": "SKU-SUB-001",
               "item_variant": "485646409345616",
               "price": "100",
               "quantity": "1",
               "variant_name": "Monthly Plan"
           }
        ]
    },
    "user_data": {
        "city": "Rotterdam",
        "country": "NL",
        "customer_id": "12349878",
        "email": "example@eykdata.com",
        "first_name": "Eyk",
        "last_name": "Data",
        "phone": "+31612345678",
        "region": "Zuid-Holland",
        "street": "Stationsplein",
        "zip": "3013AK",
        "new_customer": true
    }
}