vantevo-analytics-tracker
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

The analytics of your website, but simpler

Vantevo Analytics is the alternative platform to Google Analytics that respects privacy, because it does not need cookies not compliant with the GDPR. Easy to use, light and can be integrated into any website and back-end.

For more information visit the website vantevo.io.

Installation

npm install vantevo-analytics-tracker

Usage

To start tracking page views and events, you need to initialize your tracker first:

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({
 "excludePath": [],
 "dev": false,
 "hash": false,
 "domain": null,
 "proxyServer": null,
 "proxyServerEcommerce": null,
});

These are the parameters available for the tracker settings, all fields are optional.

Option Type Description Default
excludePath array (Optional) You can exclude one or more pages from the statistics, settings []
dev boolean (Optional) Tracker will not send data to server, please check browser console to view request information. false
hash boolean (Optional) Allows tracking based on URL hash changes. false
domain string (Optional) Use this option when the script is installed on a different domain than the one entered on Vantevo Analytics. To use this function remember to authorize the domain to be able to save the statistics, for more information read more. null
proxyServer string (Optional) If you want to use a proxy server for requests sent to Vantevo. https://api.vantevo.io/event
proxyServerEcommerce string (Optional) If you want to use a proxy server for requests sent to Vantevo for ecommerce events. https://api.vantevo.io/event-ecommerce

VantevoAnalytics() returns the functions you can use to keep track of your events.

  • vantevo(): Page views monitoring, event management and goals.

  • enableTracker(): Allows you to track page views automatically, the script uses the popstate event to navigate the site.

  • enableOutboundLinks(): Allows you to monitor all outbound links from your site automatically, the script uses the click and auxclick events.

  • enableTrackFiles(extensions , saveExtension): It allows you to automatically monitor all files to be downloaded from your site. The function has 2 parameters: extensions and saveExtension.

Option Type Description Default
extensions string (required) extensions consists of a comma separated list of extensions, example: zip, mp4, avi, mp3. Whenever a user clicks on a link, the script checks if the file extension is in the list you entered in the parameter and sends a File Download event with the value url. null
saveExtension boolean (optional) saveExtension allows you to save in the event detail together with the url also the name of the file extension as meta_key to get more information and statistics about your files to download. false
The script uses the click and auxclick events.

The script uses the addEventListener () method for the enableTracker, enableOutboundLinks and enableTrackFiles functions, to remove the registered event listener each function will return a clean function removeEventListener():

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { enableTracker, enableOutboundLinks, enableTrackFiles } = VantevoAnalytics({...});
 
const cleanTracker = enableTracker();
const cleanOutboundLinks = enableOutboundLinks();
const cleanEnableTrackFiles = enableTrackFiles("zip,mp4,avi", true);
 
cleanTracker();
cleanOutboundLinks();
cleanEnableTrackFiles();

Page view monitoring and event management

Simple Pageview

Submit a pageview using location.href as the request URL and document.title for the page title.

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({...});
 
vantevo();
/*** or ***/
vantevo("pageview");

Pageview change pathname of url

You can submit a custom pageview where you can change the pathname of the page. In the example below, the page URL is https://example.com/blog?page=2 with the pathname=/blog and thepage=2 parameter (the page = 2 parameter will be ignored, see guide), using the pageview event with the meta parameter of type {path:"/blog/page/2"} , the script will save as page pathname: /blog/page/2.

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({...});
 
vantevo("pageview", { path: "/blog/page/2" }, () => {});

Pageview change title page

Vantevo uses document.title to get the full title of the page, in this example you will see how you can change the page title.

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({...});
 
vantevo("pageview", { title: "New Title Page" }, () => {});

Event

An example of how to send an event with the name "Download" and with the information meta_key=pdf and meta_value=presentation, the meta parameter is a simple json.

Vantevo Analytics handles the meta_key=duration, the value of this field is of type Number. With the duration parameter it is possible to send a number (seconds) with the event that will be used to calculate the average duration of the event itself.

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({...});
 
vantevo("download", { pdf: "presentation" }, () => {});
/*** or ***/
vantevo("video", { title: "presentation", duration: 30 }, () => {});
 

Parameters

Option Type Description Default
event string (required) Event Name. pageview
values object (required) An object with custom properties for events. {}
callback function (optional) A function that is called once the event has been successfully logged. null

Monitoring Ecommerce

In the ecommerce section of Vantevo you can monitor specific actions affecting your ecommerce website and the sources of traffic that lead to sales.

Parameters

Option Type Description Default
event string (required) Event Name. See below the list of events you can use for monitoring your ecommerce. pageview
values object (required) An object with custom properties for events. {}
callback function (optional) A function that is called once the event has been successfully logged. null

List events

These are the events to use to monitor your ecommerce:

Event Description
add_to_wishlist a user adds a product to the favorites list
view_item a user views a product
remove_item_cart a user removes a product from the cart
add_item_cart a user adds product to the cart
start_checkout a user has started the checkout process
checkout_info a user submits personal data
checkout_ship a user submits shipments data
checkout_payment a user initiated the payment process
purchase a user has completed a purchase

Example

An example for how to use the trackEcommerce function.

const { trackEcommerce } = VantevoAnalytics({...});

trackEcommerce("add_to_wishlist", { 
    "items": [
         {
            'item_id': "SKU_123",
            'item_name': "Samsung Galaxy",
            'currency': "EUR",
            'quantity': 1,
            'price': 199.99,
            'discount': 0,
            'position': 1,
            'brand': "Samsung",
            'category_1': "Smartphone",
            'category_2': "Samsung",
            'category_3': "Galaxy",
            'category_4': "",
            'category_5': "",
            'variant_1': "Black",
            'variant_2': "5.5 inch",
            'variant_3': ""
        }
    ]
});

Read our guide for more information of how to use the ecommerce tracking function.

404 - Page Not Found

For the management of the error 404 - Page Not Found page we have created a specific event. This function will automatically save a 404 event and the pathname of the page as a value.

You can find the information collected through this function on the Events page.

import VantevoAnalytics from "vantevo-analytics-tracker";
 
const { vantevo } = VantevoAnalytics({...});
 
vantevo("404", {}, () => {}));

Vantevo Analytics guide

To see all the features and settings of Vantevo Analytics we recommend that you read our complete guide here.

Package Sidebar

Install

npm i vantevo-analytics-tracker

Weekly Downloads

4

Version

1.0.3

License

MIT

Unpacked Size

94.3 kB

Total Files

14

Last publish

Collaborators

  • vantevo