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
`totals`	Ottieni 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.
`pages`	Lista con tutte le pagine visitate
`entry-pages`	Lista con tutte le pagine in entrata
`exit-pages`	Lista con tutte le pagine in uscita
`referrals`	Lista con tutti i refferals
`utm-source`	UTM source
`utm-medium`	UTM medium
`utm-campaign`	UTM campaign
`utm-content`	UTM content
`utm-term`	UTM term
`devices`	Lista con tutti i tipi di dispositivi
`browsers`	Lista con tutti i tipi di browser
`os`	Lista con tutti i sistemi operativi
`screen`	Lista con tutti le dimensioni dello schermo
`countries`	Lista con tutti i paesi dei tuoi visitatori
`regions`	Lista con tutte le regioni dei tuoi visitatori
`cities`	Lista con tutte le città dei tuoi visitatori
`languages`	Lista con tutte le lingue dei tuoi visitatori
`goals`	Lista con tutti gli obiettivi
`events`	Lista 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.

Filtro	Descrizione
`page`	Ti permette di filtrare i risultati in base a una specifica pagina, il valore del campo deve essere un pathname , esempio: `/contacts`
`entry_page`	Ti permette di filtrare i risultati in base a una specifica pagina in entrata, il valore del campo deve essere un pathname , esempio: `/`
`exit_page`	Ti permette di filtrare i risultati in base a una specifica pagina in uscita, il valore del campo deve essere un pathname , esempio: `/`
`device`	Ti permette di filtrare i risultati in base un dispositivo, esempio: `Desktop`
`os`	Ti permette di filtrare i risultati in base al sistemo operativo, esempio: `Windows`
`os_version`	Ti permette di filtrare i risultati in base alla versione del sistemo operativo, esempio: `10`. Funziona insieme al filtro `os`.
`browser`	Ti permette di filtrare i risultati in base al nome del browser, esempio: `Chrome`
`browser_version`	Ti permette di filtrare i risultati in base alla versione del browser, esempio: `100.0.4896.75`. Funziona insieme al filtro `browser`.
`screen_class`	Ti permette di filtrare i risultati in base alla dimensione dello schermo, esempio: `XL`
`country`	Ti permette di filtrare i risultati in base al paese, esempio: `IT`
`region`	Ti permette di filtrare i risultati in base alla regione, esempio: `Lazio`
`city`	Ti permette di filtrare i risultati in base alla città, esempio: `Rome`
`language`	Ti permette di filtrare i risultati in base alla lingua, esempio: `IT`
`referrer_name`	Ti permette di filtrare i risultati in base al referrer, esempio: `Bing`
`referrer`	Ti permette di filtrare i risultati in base al referrer, esempio: `https://bing.com`
`utm_source`	Ti permette di filtrare i risultati in base al paramentro UTM Source
`utm_medium`	Ti permette di filtrare i risultati in base al paramentro UTM Medium
`utm_campaign`	Ti permette di filtrare i risultati in base al paramentro UTM Campaign
`utm_content`	Ti permette di filtrare i risultati in base al paramentro UTM Content
`utm_term`	Ti permette di filtrare i risultati in base al paramentro UTM Term
`event`	Ti permette di filtrare i risultati in base a un specifico evento , esempip: `File Download` , questo filtro viene utilizzato nelle richieste degli eventi.
`event_key`	Ti permette di filtrare i risultati in base a valore `event_key` , questo filtro viene utilizzato nelle richieste degli eventi.
`event_value`	Ti permette di filtrare i risultati in base a valore `event_value` , questo filtro viene utilizzato nelle richieste degli eventi.
`goals`	Ti permette di filtrare i risultati per un specifico obiettivo. Only for `/v1/stats`

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
        }
        ...
    ]
}

Parametri​

period​

domain​

source​

limit​

offset​

filtri​

Gestione errori​

Statistiche​

GET /v1/stats​

Esempio source totals​

Esempio source pages​

Esempio source referrals​

Esempio source OS​

Esempio source pages con filtro browser​

Eventi​

GET /v1/events​

Esempio source totals​

Esempio source events​

Esempio source events con filtro page​

Parametri

period

domain

source

limit

offset

filtri

Gestione errori

Statistiche

GET /v1/stats

Esempio source totals

Esempio source pages

Esempio source referrals

Esempio source OS

Esempio source pages con filtro browser

Eventi

GET /v1/events

Esempio source totals

Esempio source events

Esempio source events con filtro page