visenze-tracking-javascript

JavaScript SDK for ViSenze Analytics

Table of Contents

• visenze-tracking-javascript
  • Table of Contents
  • 1. Overview
  • 2. Setup and initialization
    • 2.1 Node
    • 2.2 Browser
    • 2.3 Run the Demo

1. Overview

Visenze Analytics is a key part of your analytics solutions, allowing you to track key events and view the resulting analytics and performance data. For more details, see ViSenze Analytics API Documentation.

The ViSenze Tracking JavaScript SDK is an open source software for easy integration of ViSearch Tracking API with your javascript application. For source code and references, visit the GitHub repository.

• Latest stable version:

2. Setup and initialization

2.1 Node

From project root directory run npm install to install the dependencies.

npm install

Replace YOUR_TRACKER_CODE with your ViSenze Analytics tracking code. It is recommended to initiate the client when the SDK is loaded into the page.

Your credentials can be found in ViSearch Dashboard

For usage with Node.js projects:

npm install visenze-tracking-javascript

// Import module
import ViSenzeAnalytics from 'visenze-tracking-javascript';

// Initialize
const vaClient = ViSenzeAnalytics({ code: 'YOUR_TRACKER_CODE' });

2.2 Browser

Include this in your page header.

<script type="text/javascript" src="https://cdn.visenze.com/visearch/dist/js/tracking.2.0.0.js"></script>

Initialize.

// Initialize
var vaClient = ViSenzeAnalytics({ code: 'YOUR_TRACKER_CODE' });

2.3 Run the Demo

This repository comes with an example of the SDK usage. In order to run the examples, a Node.js environment is required.

You will need to fill up your tracking code in the relevant demo files.

To run the Node.js demo:

node testSDK

To run the web page demo:

npm run write-version
npm run start

After the above command, the demo pages will be accessible at http://localhost:8080/index.html