Passa al contenuto principale

API Statistiche

L'API Vantevo offre un modo per recuperare le tue statistiche a livello di codice.

L'API accetta richieste GET insieme ad query parametri e restituisce risposte HTTP standard insieme a un corpo di tipo JSON. Tutte le richieste API devono essere effettuate tramite HTTPS.

Ogni richiesta deve essere autenticata con una chiave API utilizzando il metodo Bearer Token. Puoi ottenere una chiave API per il tuo account andando alla pagina delle impostazioni del tuo account.

Parametri

period

period Required

  • day - oggi
  • yesterday - ieri
  • 1m - questo mese
  • 1y - questo anno
  • 7d - ultimi 7 giorni
  • 30d - ultimi 30 giorni
  • 6m - ultimi 6 mesi
  • 12m - ultimi 12 mesi
  • custom - puoi inserire un intevallo di date personalizzato

Quando si utilizza un intervallo personalizzato custom, devi aggiungere altri due paramentri date formattate ISO-8601 ; start e end. Le statistiche verranno restituite per l'intero intervallo di date comprese tra data inizio e data fine.

  • start - "yyyy-mm-dd"
  • end - "yyyy-mm-dd"

domain

domain Required

Inserire il nome del dominio salvato su Vantevo.


source

source Required

Source
Descrizione
totalsOttieni il numero di visitatori unici, frequenza di rimbalzo, sessioni, durata media e numeri di pagina visualizzate del periodo corrente e del periodo precendente, ti aiuta a fare il confronto tra i 2 periodi.
pagesLista con tutte le pagine visitate
entry-pagesLista con tutte le pagine in entrata
exit-pagesLista con tutte le pagine in uscita
referralsLista con tutti i refferals
utm-sourceUTM source
utm-mediumUTM medium
utm-campaignUTM campaign
utm-contentUTM content
utm-termUTM term
devicesLista con tutti i tipi di dispositivi
browsersLista con tutti i tipi di browser
osLista con tutti i sistemi operativi
screenLista con tutti le dimensioni dello schermo
countriesLista con tutti i paesi dei tuoi visitatori
regionsLista con tutte le regioni dei tuoi visitatori
citiesLista con tutte le città dei tuoi visitatori
languagesLista con tutte le lingue dei tuoi visitatori
goalsLista con tutti gli obiettivi
eventsLista con tutti gli eventi

limit

limit Optional

Default: 30

Ti permette di gestire il sistema pagination. Il numero massimo che puoi chiedere è di 50 record.


offset

offset Optional

Default: 0

Ti permette di gestire il sistema pagination.


filtri

Optional

L'elenco seguente contiene tutte le possibili opzioni di filtro.

FiltroDescrizione
pageTi permette di filtrare i risultati in base a una specifica pagina, il valore del campo deve essere un pathname , esempio: /contacts
entry_pageTi permette di filtrare i risultati in base a una specifica pagina in entrata, il valore del campo deve essere un pathname , esempio: /
exit_pageTi permette di filtrare i risultati in base a una specifica pagina in uscita, il valore del campo deve essere un pathname , esempio: /
deviceTi permette di filtrare i risultati in base un dispositivo, esempio: Desktop
osTi permette di filtrare i risultati in base al sistemo operativo, esempio: Windows
os_versionTi permette di filtrare i risultati in base alla versione del sistemo operativo, esempio: 10. Funziona insieme al filtro os.
browserTi permette di filtrare i risultati in base al nome del browser, esempio: Chrome
browser_versionTi permette di filtrare i risultati in base alla versione del browser, esempio: 100.0.4896.75. Funziona insieme al filtro browser.
screen_classTi permette di filtrare i risultati in base alla dimensione dello schermo, esempio: XL
countryTi permette di filtrare i risultati in base al paese, esempio: IT
regionTi permette di filtrare i risultati in base alla regione, esempio: Lazio
cityTi permette di filtrare i risultati in base alla città, esempio: Rome
languageTi permette di filtrare i risultati in base alla lingua, esempio: IT
referrer_nameTi permette di filtrare i risultati in base al referrer, esempio: Bing
referrerTi permette di filtrare i risultati in base al referrer, esempio: https://bing.com
utm_sourceTi permette di filtrare i risultati in base al paramentro UTM Source
utm_mediumTi permette di filtrare i risultati in base al paramentro UTM Medium
utm_campaignTi permette di filtrare i risultati in base al paramentro UTM Campaign
utm_contentTi permette di filtrare i risultati in base al paramentro UTM Content
utm_termTi permette di filtrare i risultati in base al paramentro UTM Term
eventTi permette di filtrare i risultati in base a un specifico evento , esempip: File Download , questo filtro viene utilizzato nelle richieste degli eventi.
event_keyTi permette di filtrare i risultati in base a valore event_key , questo filtro viene utilizzato nelle richieste degli eventi.
event_valueTi permette di filtrare i risultati in base a valore event_value , questo filtro viene utilizzato nelle richieste degli eventi.
goalsTi permette di filtrare i risultati per un specifico obiettivo.

Gestione errori

  • 401 - quando manca uno dei parametri obbligatori oppure uno dei parametri non è valido
  • 200 - messaggio Wrong period filter. - il valore del parametro period è sbagliato
  • 200 - messaggio Wrong start date time. - il valore del parametro start è sbagliato
  • 200 - messaggio Wrong end date time. - il valore del parametro end è sbagliato

Statistiche

I seguenti endpoint possono essere utilizzati per leggere le statistiche da Vantevo.

GET /v1/stats

Esempio source totals

Con questa richiesta ottieni: numero di visitatori unici, numero di pagine visitate, frequenza di rimbalzo, sessioni e la durata media del periodo corrente e del periodo precendente, ti aiuta a fare il confronto tra i 2 periodi.

Richiesta totals
curl --location --request GET 'https://api.vantevo.io/v1/stats?period=1m&domain=example.com&source=totals' \
--header 'Authorization: Bearer {token} \
Risposta totals
{
"current": {
"visitors": 206,
"bounce_rate": 57.82,
"duration": 42,
"sessions": 211,
"page_views": 410
},
"last": {
"visitors": 199,
"bounce_rate": 50.95,
"duration": 83,
"sessions": 210,
"page_views": 504
}
}

Esempio source pages

Torna la lista di tutte le pagine visitate

Richiesta pages
curl --location --request GET 'https://api.vantevo.io/v1/stats?period=1m&domain=example.com&source=pages' \
--header 'Authorization: Bearer {token} \
Risposta pages
{
"data": [
{
"visitors": 95,
"path": "/",
"title": "Example Title",
"domain": "https://www.example.com",
"visits": 121,
"duration": 14,
"bounce": 38,
"count": 96
},
...
]
}

Esempio source referrals

Torna la lista di tutti i referrals

Richiesta referrals
curl --location --request GET 'https://api.vantevo.io/v1/stats?period=1m&domain=example.com&source=referrals' \
--header 'Authorization: Bearer {token} \
Risposta referrals
{
"data": [
{
"name": "Google",
"referrer": "https://www.google.com",
"visitors": 109
},
...
]
}

Esempio source OS

Torna la lista di tutti i sistemi operativi dei tuoi visitatori

Richiesta os
curl --location --request GET 'https://api.vantevo.io/v1/stats?period=1m&domain=example.com&source=os' \
--header 'Authorization: Bearer {token} \
Risposta os
{
"data": [
{
"name": "Windows",
"visitors": 715
},
...
]
}

Esempio source pages con filtro browser

Torna la lista di tutte le pagina filtrare in base al browser

Richiesta pages con filtro browser
curl --location --request GET 'https://api.vantevo.io/v1/stats?period=1m&domain=example.com&source=pages&browser=Chrome' \
--header 'Authorization: Bearer {token} \
Risposta pages con filtro browser
{
"data": [
{
"visitors": 95,
"path": "/",
"title": "Example Title",
"domain": "https://www.example.com",
"visits": 99,
"duration": 12,
"bounce": 24,
"count": 12
},
...
]
}

Eventi

I seguenti endpoint possono essere utilizzati per leggere le statistiche degli eventi da Vantevo.

GET /v1/events

Esempio source totals

Con questa richiesta ottieni: numero di visitatori unici, numero di eventi unici , totale eventi e totale visitori del periodo corrente e del periodo precendente, ti aiuta a fare il confronto tra i 2 periodi.

Richiesta totals
curl --location --request GET 'https://api.vantevo.io/v1/events?period=1m&domain=example.com&source=totals' \
--header 'Authorization: Bearer {token} \
Risposta totals
{
"current": {
"visitors": 326,
"events": 71,
"unique_events": 3,
"uniq_visitors": 57
},
"last": {
"visitors": 175,
"events": 41,
"unique_events": 1,
"uniq_visitors": 22
}
}

Esempio source events

Torna la lista di tutti gli eventi dei tuoi visitatori

Richiesta events
curl --location --request GET 'https://api.vantevo.io/v1/events?period=1m&domain=example.com&source=events' \
--header 'Authorization: Bearer {token} \
Risposta events
{
"data": [
{
"name": "Search",
"events": 122,
"visitors": 52,
"duration": 0
},
{
"name": "Outbound Link",
"events": 44,
"visitors": 23,
"duration": 0
}
...
]
}

Esempio source events con filtro page

Torna la lista di tutti gli eventi dei tuoi visitatori filtrati per una specifica pagina

Richiesta events con filtro page
curl --location --request GET 'https://api.vantevo.io/v1/events?period=1m&domain=example.com&source=events&page=%2Fexample' \
--header 'Authorization: Bearer {token} \
Risposta events con filtro page
{
"data": [
{
"name": "Video Example",
"events": 60,
"visitors": 47,
"duration": 29
}
...
]
}