gb-tracker-client

GroupBy Tracking Client

This can be installed via npm with npm install --save gb-tracker-client

Or it can be directly included from our CDN using:

<script src="http://cdn.groupbycloud.com/dist/gb-tracker-client-1.4.6.min.js"></scipt>

Including it directly from the CDN will create the global variable _GbTracker with the same API as below.

Recommendations API can be found here

gb-tracker-client API

var _GbTracker = require('gb-tracker-client');
var gbTracker = new GbTracker('customerId', 'area');

// Must set the visitor at least once before any events are sent
// Should be called on login/logout or any time the visitorId/sessionId change
gbTracker.setVisitor('visitorId', 'sessionId');

// There are five event API's.

// AddToBasket events
gbTracker.sendAddToCartEvent({
 cart: {
   id: 'asfasdf',                     // Optional
   items:[  
     {
        productId:  'asdfasd',
        title:      'super boat',
        price:      100.21,
        quantity:   20,
        collection: 'testcollection',  // Optional: Defaults to 'Default'
        category:   'boats',           // Optional
        sku:        'asdfasf98',       // Optional
        margin:     0.81,              // Optional
        metadata: [                    // Optional
           {
             key: 'some key',
             value: 'some value'
           }
         ]
      }
   ],
   metadata: [                          // Optional
      {
        key: 'some key',
        value: 'some value'
      }
    ]
 },
 metadata: [                            // Optional
   {
     key: 'some key',
     value: 'some value'
   }
 ]
});

// Order events
gbTracker.sendOrderEvent({
 cart: {
   id: 'asfasdf',                     // Optional
   totalItems: 1,                     // Optional
   totalQuantity: 20,                 // Optional
   totalPrice: 1039.90,               // Optional
   items:[  
     {
        productId:  'asdfasd',
        title:      'super boat',
        price:      100.21,
        quantity:   20,
        collection: 'testcollection',  // Optional: Defaults to 'Default'
        category:   'boats',           // Optional
        sku:        'asdfasf98',       // Optional
        margin:     0.81,              // Optional
        metadata: [                    // Optional
           {
             key: 'some key',
             value: 'some value'
           }
         ]
      }
   ],
   metadata: [                          // Optional
      {
        key: 'some key',
        value: 'some value'
      }
    ]
 },
 metadata: [                            // Optional
   {
     key: 'some key',
     value: 'some value'
   }
 ]
});

// Search events
gbTracker.sendSearchEvent({
  search:   {
    origin:           {                       // Optional: Search defaults to true
      recommendations: false,
      dym:             false,
      sayt:            false,
      search:          true
    },
    totalRecordCount: 122,
    area:             'Default',
    biasingProfile:   'ThisBiasingProfile',   // Optional
    query:            'i searched for this',
    pageInfo: {           
      recordStart: 1,
      recordEnd:   24
    },
    matchStrategy: {                          // Optional: matchStrategy returned by searchandiser
      rules: [
        {
          termsGreaterThan: 1,
          mustMatch:        100,
          percentage:       true
        }
      ]
    },
    availableNavigation: [                    // Optional: Array of selectedNavigations returned by searchandiser
      {
        name:        'reg_price',
        displayName: 'Price',
        refinements: [
          {
            type:  'Range',
            count: 3,
            high:  '50',
            low:   '20'
          },
          {
            type:  'Range',
            count: 25,
            high:  '100',
            low:   '50'
          },
          {
            type:  'Range',
            count: 84,
            high:  '150',
            low:   '100'
          },
          {
            type:  'Range',
            count: 10,
            high:  '200',
            low:   '150'
          }
        ],
        metadata: [],
        range:    true,
        or:       false
      }
    ],
    selectedNavigation: [],  // Optional: Array of selectedNavigations returned by searchandiser
    records:            [],  // Optional: Array of records returned by searchandiser
    didYouMean: [
      'I should have searched for this'
    ]
  }
});

// Auto Search events
gbTracker.sendAutoSearchEvent({
  // Provided in search response from API
  responseId: 'e30a4611-64b0-49a1-ad56-ab8fa2ffcc10',   
  search:   {
    origin:           {              // Optional: Search defaults to true  
      recommendations: false,
      dym:             false,
      sayt:            false,
      search:          true
    }    
 }
});

// ViewProduct events
gbTracker.sendViewProductEvent({
 product:  {
   productId:  'asdfasd',
   title:      'super boat',
   price:      100.21,
   collection: 'testcollection',  // Optional: Defaults to 'Default'
   category:   'boats',           // Optional
   sku:        'asdfasf98',       // Optional
   margin:     0.81,              // Optional
   metadata: [                    // Optional
      {
        key: 'some key',
        value: 'some value'
      }
    ]
 },
 metadata: [                            // Optional
   {
     key: 'some key',
     value: 'some value'
   }
 ]
});

// There are also navigation events, which are sent silently when page or URL changes