Web Analytics Drains Reference
If a Web Analytics Drains has been configured, Vercel will send page views and custom events from your applications to external endpoints for storage and analysis over HTTPS when your application tracks events.
The following table describes the possible fields that are sent via Web Analytics Drains:
| Name | Type | Description | Example |
|---|---|---|---|
schema | string | Schema version identifier | vercel.analytics.v1 |
eventType | string | Type of analytics event | pageview or event |
eventName | string | Name of the custom event | button_click |
eventData | string | Additional data associated with the event | {"button": "signup"} |
timestamp | number | Unix timestamp when the event was recorded | 1694723400000 |
projectId | string | Identifier for the Vercel project | Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2 |
ownerId | string | Identifier for the project owner | team_nLlpyC6REAqxydlFKbrMDlud |
dataSourceName | string | Name of the data source | web-analytics |
sessionId | number | Unique session identifier | 12345 |
deviceId | number | Unique device identifier | 67890 |
origin | string | Origin URL where the event was recorded | https://example.com |
path | string | URL path where the event was recorded | /dashboard |
referrer | string | Referrer URL | https://google.com |
queryParams | string | Query parameters from the URL | utm_source=google&utm_medium=cpc |
route | string | Route pattern for the page | /dashboard/[id] |
country | string | Country code of the user | US |
region | string | Region code of the user | CA |
city | string | City of the user | San Francisco |
osName | string | Operating system name | macOS |
osVersion | string | Operating system version | 13.4 |
clientName | string | Client browser name | Chrome |
clientType | string | Type of client | browser |
clientVersion | string | Client browser version | 114.0.5735.90 |
deviceType | string | Type of device | desktop |
deviceBrand | string | Device brand | Apple |
deviceModel | string | Device model | MacBook Pro |
browserEngine | string | Browser engine name | Blink |
browserEngineVersion | string | Browser engine version | 114.0.5735.90 |
sdkVersion | string | SDK version used to track events | 2.1.0 |
sdkName | string | SDK name used to track events | @vercel/analytics |
sdkVersionFull | string | Full SDK version string | 2.1.0-beta.1 |
vercelEnvironment | string | Vercel environment | production |
vercelUrl | string | Vercel deployment URL | *.vercel.app |
flags | string | Feature flags information | {"feature_a": true} |
deployment | string | Identifier for the Vercel deployment | dpl_2YZzo1cJAjijSf1hwDFK5ayu2Pid |
Vercel supports the following formats for Web Analytics Drains, which you can configure when setting the Drain destination:
Vercel sends Web Analytics data as JSON arrays containing event objects:
[
{ "schema": "vercel.analytics.v1", "eventType": "pageview", "timestamp": 1694723400000, "projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2", "ownerId": "team_nLlpyC6REAqxydlFKbrMDlud", "dataSourceName": "web-analytics", "sessionId": 12345, "deviceId": 67890, "origin": "https://example.com", "path": "/dashboard" },
{ "schema": "vercel.analytics.v1", "eventType": "event", "eventName": "button_click", "eventData": "{\"button\": \"signup\"}", "timestamp": 1694723405000, "projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2", "ownerId": "team_nLlpyC6REAqxydlFKbrMDlud", "dataSourceName": "web-analytics", "sessionId": 12345, "deviceId": 67890, "origin": "https://example.com", "path": "/signup" }
]Vercel sends Web Analytics data as newline-delimited JSON objects:
{"schema": "vercel.analytics.v1","eventType": "pageview","timestamp": 1694723400000,"projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2","ownerId": "team_nLlpyC6REAqxydlFKbrMDlud","dataSourceName": "web-analytics","sessionId": 12345,"deviceId": 67890,"origin": "https://example.com","path": "/dashboard"}
{"schema": "vercel.analytics.v1","eventType": "event","eventName": "button_click","eventData": "{\"button\": \"signup\"}","timestamp": 1694723405000,"projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2","ownerId": "team_nLlpyC6REAqxydlFKbrMDlud","dataSourceName": "web-analytics","sessionId": 12345,"deviceId": 67890,"origin": "https://example.com","path": "/signup"}When you configure a Web Analytics Drain in the Vercel UI, you can set the sampling rate to control the volume of data sent. This helps manage costs when you have high traffic volumes.
For more information on Web Analytics Drains and how to use them, refer to the following resources:
Was this helpful?