Last updated

trackFairshareEvent()

Tracks a custom event for analytics.

Signature

window.FairShareSDK.trackFairshareEvent(eventData);

Parameters

ParameterTypeDescription
eventDataobjectEvent data object

Event Data Object:

PropertyTypeDescription
eventstringEvent name
propertiesobjectEvent properties

Examples

Product View

window.FairShareSDK.trackFairshareEvent({
  event: "product_viewed",
  properties: {
    product_id: 123,
    product_name: "Premium Widget",
    price: 29.99,
    currency: "USD",
  },
});

Add to Cart

window.FairShareSDK.trackFairshareEvent({
  event: "product_added_to_cart",
  properties: {
    product_id: 123,
    quantity: 2,
    variant_id: 456,
  },
});

Page View

window.FairShareSDK.trackFairshareEvent({
  event: "page_viewed",
  properties: {
    page_title: document.title,
    page_url: window.location.href,
  },
});

Custom Conversion

window.FairShareSDK.trackFairshareEvent({
  event: "lead_captured",
  properties: {
    form_name: "newsletter_signup",
    source: "homepage_banner",
  },
});

Best Practices

  • Use snake_case for event names
  • Use past tense for completed actions (product_viewed, cart_updated)
  • Use present tense for ongoing states (checkout_started)