visenze-tracking-javascript
v3.0.0
Published
ViSenze tracking JavaScript SDK for users to send user defined data tracking event to ViSenze for performance monitoring and analytics purpose
Downloads
2,142
Readme
visenze-tracking-javascript
JavaScript SDK for ViSenze Analytics
Table of Contents
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 ViSenze Analytics API with your JavaScript application, including web pages. For source code and references, visit the GitHub repository.
- Latest stable version:
2. Setup and initialization
2.1 Node
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' });
Replace YOUR_TRACKER_CODE
with your ViSenze Analytics tracking code.
It is recommended to initialize the client when the SDK is loaded into the page.
Your credentials can be found in ViSenze console.
2.2 Browser
Include this in your page header.
<script type="text/javascript" src="https://cdn.visenze.com/visearch/dist/js/tracking.3.0.0.js"></script>
Initialize as follows:
// Initialize
var vaClient = ViSenzeAnalytics({ code: 'YOUR_TRACKER_CODE' });
Replace YOUR_TRACKER_CODE
with your ViSenze Analytics tracking code.
It is recommended to initialize the client when the SDK is loaded into the page.
Your credentials can be found in ViSenze console.
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 demo:
npm run write-version
npm run start
After the above command, the demo pages will be accessible at http://localhost:8080/index.html
.