API Event
L'API degli eventi possono essere utilizzate per registrare visualizzazioni di pagina ed eventi personalizzati. Ciò è utile durante il monitoraggio di app mobili Android o iOS o per il monitoraggio lato server.
Nella maggior parte dei casi consigliamo di installare Vantevo tramite il nostro script fornito o uno dei tanti pacchetti di integrazione elencati qui. Tuttavia, se non c'è un modo semplice per integrarti con Vantevo, puoi comunque farlo inviando eventi direttamente alla nostra API.
POST /v1/event
Registra una visualizzazione di pagina o un evento personalizzato.
Molto importante assicurati di inviare le intestazioni corrette:
- User-Agent viene utilizzato per determinare il dispositivo dell'utente
- X-Forwarded-For viene utilizzato per determinare l'indirizzo IP del client e creare la sessione
- Content-Type deve essere application/json
Esempio
curl --location --request POST 'https://api.vantevo.io/v1/event'
--header 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36'
--header 'X-Forwarded-For: 127.0.0.1'
--header 'Content-Type: application/json'
--data-raw '{ "event": "pageview", "url": "https://www.example.com", referrer: null, "width": 0, "height": 0, domain: null, "meta": {} }'
Parametri
Option | Type | Description | Default |
---|---|---|---|
event | string (Required) | Per la visualizzazione di pagine devi utilizzare pageview , per un evento personalizzato puoi utilizzare qualsiasi nome per il tuo evento. | pageview |
url | string (Required) | URL della pagina in cui è stato attivato l'evento. Se l'URL contiene parametri UTM, verranno utilizzati. Lo script di vantevo utilizza window.location.href per questo campo. Il formato dell'URL deve essere: https://example.com/page | null |
title | string (Optional) | Il titolo della pagina , se non viene fornito vantevo scrivera l'url come titolo | null |
referrer | string (Optional) | Referrer per questo evento. Lo script di vantevo utilizzao document.referrer per questo campo. | null |
width | number (Optional) | Lo script di vantevo utilizzao window.innerWidth per questo campo. | 0 |
height | number (Optional) | Lo script di vantevo utilizzao window.innerHeight per questo campo. | 0 |
domain | string (Optional) | Il nome del dominio registrato su Vantevo Analytics, da utilizzare solo in caso quando il campo url ha un dominio diverso. É il nome del dominio che hai utilizzato quando hai aggiunto il tuo sito al tuo account Vantevo. | null |
meta | Object (Optional) | Proprietà personalizzate per l'evento. Vedi Proprietà meta per gli eventi personalizzate | {} |