vantevo-analytics-sdk v1.0.1

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.

This is the official JavaScript client SDK for Vantevo Analytics. For more information visit the website vantevo.io.

Installation

npm install vantevo-analytics-sdk

Usage

To start tracking page views, events, and getting statistics, you need to initialize the client first:

const { VantevoAnalytics } = require("vantevo-analytics-sdk");

var client = new VantevoAnalytics({
  accessToken: "",
  domain: "",
  protocol: "",
  userAgent: "",
  xForwardedFor: "",
  dev: false,
});

Tracking page views and events

Parameters

Event parameters | Option | Type | Description | | ------------- | --------------------- | ----------------------------| | event | string (required) | Event name, remember that the name pageview will send a pageview event. | | url | string (required) | Enter url you want to save in the statistics. | | title | string (optional) | You can insert a title of the page, if this field is not used vantevo will insert the pathname of the url used. | | referrer | string (optional) | In this field you can enter a referrer for your request. Default: null. | | width | string (optional) | This field is used to save the screen size. Default: 0.| | height | string (optional) | This field is used to save the screen size. Default: 0. | | meta | object (optional) | Enter the event values meta_key andmeta_value, read more how to create an event Default: {}. |

const { VantevoAnalytics } = require("vantevo-analytics-sdk");

var client = new VantevoAnalytics({....});

//without global useragent and ip
client.event({event: "pageview", url: "https://example.com/page" },  "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36", "92.16.12.2");

//with global useragent and ip
client.event({event: "pageview", url: "https://example.com/page"});

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

Event parameters | Option | Type | Description | | ------------- | --------------------- | ----------------------------| | event | string (required) | Event name, remember that the name pageview will send a pageview event. | | url | string (required) | Enter url you want to save in the statistics. | | title | string (optional) | You can insert a title of the page, if this field is not used vantevo will insert the pathname of the url used. | | referrer | string (optional) | In this field you can enter a referrer for your request. Default: null. | | width | string (optional) | This field is used to save the screen size. Default: 0.| | height | string (optional) | This field is used to save the screen size. Default: 0. | | total | number (optional) | The total amount of the order Example: 1255.00 Default: 0. | | coupon | string (optional) | The name of the coupon used. Example: newsletter | | coupon_value | number (optional) | The value of the coupon used. Example: 45.00 | | payment_type | string (optional) | The mode of payment. Example: Payal o Carta di credito. | | items | array (required) | The product information, read more. |

List events

These are the events to use to monitor your ecommerce:

Example

An example for how to use the trackEcommerce function.

client.trackEcommerce(
  {
    event: "view_item",
    items: [
      {
        item_id: "SKU_123",
        item_name: "Samsung Galaxy",
        currency: "EUR",
        quantity: 0,
        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: "",
      },
    ],
    url: "https://example.com/samsung-galaxy"
  },
  "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
  "92.16.12.2"
);

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

Express js

To use express js middleware make sure the script can get useragent and the ip, to get the data the script uses req["useragent"] and req.headers['x-forwarded-for'].

const express = require('express');
const { VantevoAnalytics } = require("vantevo-analytics-sdk");
const app = express();

var client = new VantevoAnalytics({....});
app.use(client.express());

How to get the statistics data

Parameters

Example Statistics

const { VantevoAnalytics } = require("vantevo-analytics-sdk");
var client = new VantevoAnalytics({....});

client.stats({source: 'pages', period: "1m", limit: 30, offset: 0, city: "Rome", ....}).then(() => {}).catch(() => {});

Example Events

const { VantevoAnalytics } = require("vantevo-analytics-sdk");
var client = new VantevoAnalytics({....});

client.events({source: 'events', period: "1m", limit: 30, offset: 0, city: "Rome", ....}).then(() => {}).catch(() => {});

Vantevo Analytics guide

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