Javascript SDK

JavaScript SDK è disponibile su GitHub o npm.

Installazione

npm install vantevo-analytics-sdk

Utilizzo

Per iniziare a monitorare le visualizzazioni di pagina, gli eventi e ottenere statistiche, devi prima inizializzare il client:

Opzione	Tipo	Descrizione
accessToken	string (required)	Per creare una chiave API leggi la nostra guida.
domain	string (required)	Inserisci il dominio che desideri utilizzare per raccogliere le statistiche. Il dominio non deve includere http, https o www. Esempio: esempio.com
protocol	string (required)	http or https
userAgent	string (optional)	Per monitorare le visualizzazioni di pagina e gli eventi, le richieste devono avere un user-agent, qui puoi anche assegnare un user-agent globale.
xForwardedFor	string (optional)	Per monitorare le visualizzazioni di pagina e gli eventi, le richieste devono avere un ip, qui puoi assegnare un ip globale.
dev	boolean (optional)	Il tracker non invierà dati al server, controlla la console/log file per visualizzare le informazioni sulla richiesta.

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

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

Monitoraggio delle visualizzazioni di pagina e degli eventi

Parametri

Opzione	Tipo	Descrizione
event	object (required)	Vedere i parametri dell'evento.
userAgent	string (optional)	Per monitorare le visualizzazioni di pagina e gli eventi, le richieste devono avere un user-agent, puoi usare questo parametro se non hai uno user-agent globale.
xForwardedFor	string (optional)	Per monitorare le visualizzazioni di pagina e le richieste di eventi devono avere un ip, puoi usare questo parametro se non hai un ip globale.

Parametri Event

Opzione	Tipo	Descrizione
event	string (required)	Nome dell'evento, ricorda che il nome pageview invierà un evento pageview.
url	string (required)	Inserisci l'URL che vuoi salvare nelle statistiche.
title	string (optional)	Puoi inserire un titolo della pagina, se questo campo non viene utilizzato vantevo inserirà il percorso dell'url utilizzato.
referrer	string (optional)	In questo campo puoi inserire un referrer per la tua richiesta. Predefinito: null.
width	string (optional)	Questo campo viene utilizzato per salvare le dimensioni dello schermo. Predefinito: 0.
height	string (optional)	Questo campo viene utilizzato per salvare le dimensioni dello schermo. Predefinito: 0.
meta	object (optional)	Inserisci i valori dell'evento meta_key e meta_value, leggi di più come creare un evento Default: {}.

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

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

//without global useragent and ip
client.event({event: "pageview"},  "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"});

Express js

Per utilizzare il middleware js express assicurati che lo script possa ottenere useragent e ip, per ottenere i dati lo script usa req["useragent"] e 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());

Come ottenere le statistiche

Parameters

Opzione	Tipo	Descrizione
filters	object (required)	Consulta la nostra guida per vedere tutti i filtri che puoi utilizzare come, clicca qui.

Esempio statistiche pagine

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

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

Esempio statistiche eventi

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

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