Skip to content
VercelVercel
'; user_status_content.firstChild.appendChild(avatarContainer); } else { // Placeholder for LoggedOutUserMenu let loggedOutContainer = document.createElement('div'); // if LoggedOutUserMenu fallback let userBtn = document.createElement('button'); userBtn.style.width = "33px"; userBtn.style.height = "33px"; userBtn.style.display = "flex"; userBtn.style.alignItems = "center"; userBtn.style.justifyContent = "center"; userBtn.style.color = "var(--ds-gray-900)"; userBtn.style.border = "1px solid var(--ds-gray-300)"; userBtn.style.borderRadius = "100%"; userBtn.style.cursor = "pointer"; userBtn.style.background = "transparent"; userBtn.style.padding = "0"; // user icon ( from geist) let svg = document.createElementNS('http://www.w3.org/2000/svg', 'svg'); svg.setAttribute('data-testid', 'geist-icon'); svg.setAttribute('height', '16'); svg.setAttribute('stroke-linejoin', 'round'); svg.setAttribute('style', 'color:currentColor'); svg.setAttribute('viewBox', '0 0 16 16'); svg.setAttribute('width', '16'); let path = document.createElementNS('http://www.w3.org/2000/svg', 'path'); path.setAttribute('fill-rule', 'evenodd'); path.setAttribute('clip-rule', 'evenodd'); path.setAttribute('d', 'M7.75 0C5.95507 0 4.5 1.45507 4.5 3.25V3.75C4.5 5.54493 5.95507 7 7.75 7H8.25C10.0449 7 11.5 5.54493 11.5 3.75V3.25C11.5 1.45507 10.0449 0 8.25 0H7.75ZM6 3.25C6 2.2835 6.7835 1.5 7.75 1.5H8.25C9.2165 1.5 10 2.2835 10 3.25V3.75C10 4.7165 9.2165 5.5 8.25 5.5H7.75C6.7835 5.5 6 4.7165 6 3.75V3.25ZM2.5 14.5V13.1709C3.31958 11.5377 4.99308 10.5 6.82945 10.5H9.17055C11.0069 10.5 12.6804 11.5377 13.5 13.1709V14.5H2.5ZM6.82945 9C4.35483 9 2.10604 10.4388 1.06903 12.6857L1 12.8353V13V15.25V16H1.75H14.25H15V15.25V13V12.8353L14.931 12.6857C13.894 10.4388 11.6452 9 9.17055 9H6.82945Z'); path.setAttribute('fill', 'currentColor'); svg.appendChild(path); userBtn.appendChild(svg); loggedOutContainer.appendChild(userBtn); loggedOutContainer.style.display = 'flex'; loggedOutContainer.style.gap = '8px'; loggedOutContainer.style.alignItems = 'center'; user_status_content.firstChild.appendChild(loggedOutContainer); } })();
Menu

Web Analytics Drains Reference

Last updated September 24, 2025

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.

Web Analytics Schema

The following table describes the possible fields that are sent via Web Analytics Drains:

NameTypeDescriptionExample
schemastringSchema version identifiervercel.analytics.v2
eventTypestringType of analytics eventpageview or event
eventNamestringName of the custom eventbutton_click
eventDatastringAdditional data associated with the event{"button": "signup"}
timestampnumberUnix timestamp when the event was recorded1694723400000
projectIdstringIdentifier for the Vercel projectQmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2
ownerIdstringIdentifier for the project ownerteam_nLlpyC6REAqxydlFKbrMDlud
sessionIdnumberUnique session identifier12345
deviceIdnumberUnique device identifier67890
originstringOrigin URL where the event was recordedhttps://example.com
pathstringURL path where the event was recorded/dashboard
referrerstringReferrer URLhttps://google.com
queryParamsstringQuery parameters from the URLutm_source=google&utm_medium=cpc
routestringRoute pattern for the page/dashboard/[id]
countrystringCountry code of the userUS
regionstringRegion code of the userCA
citystringCity of the userSan Francisco
osNamestringOperating system namemacOS
osVersionstringOperating system version13.4
clientNamestringClient browser nameChrome
clientTypestringType of clientbrowser
clientVersionstringClient browser version114.0.5735.90
deviceTypestringType of devicedesktop
deviceBrandstringDevice brandApple
deviceModelstringDevice modelMacBook Pro
browserEnginestringBrowser engine nameBlink
browserEngineVersionstringBrowser engine version114.0.5735.90
sdkVersionstringSDK version used to track events2.1.0
sdkNamestringSDK name used to track events@vercel/analytics
sdkVersionFullstringFull SDK version string2.1.0-beta.1
vercelEnvironmentstringVercel environmentproduction
vercelUrlstringVercel deployment URL*.vercel.app
flagsstringFeature flags information{"feature_a": true}
deploymentstringIdentifier for the Vercel deploymentdpl_2YZzo1cJAjijSf1hwDFK5ayu2Pid

Format

Vercel supports the following formats for Web Analytics Drains, which you can configure when setting the Drain destination:

JSON

Vercel sends Web Analytics data as JSON arrays containing event objects:

[
  { "schema": "vercel.analytics.v2", "eventType": "pageview", "timestamp": 1694723400000, "projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2", "ownerId": "team_nLlpyC6REAqxydlFKbrMDlud", "sessionId": 12345, "deviceId": 67890, "origin": "https://example.com", "path": "/dashboard" },
  { "schema": "vercel.analytics.v2", "eventType": "event", "eventName": "button_click", "eventData": "{\"button\": \"signup\"}", "timestamp": 1694723405000, "projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2", "ownerId": "team_nLlpyC6REAqxydlFKbrMDlud", "sessionId": 12345, "deviceId": 67890, "origin": "https://example.com", "path": "/signup" }
]

NDJSON

Vercel sends Web Analytics data as newline-delimited JSON objects:

{"schema": "vercel.analytics.v2","eventType": "pageview","timestamp": 1694723400000,"projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2","ownerId": "team_nLlpyC6REAqxydlFKbrMDlud","sessionId": 12345,"deviceId": 67890,"origin": "https://example.com","path": "/dashboard"}
{"schema": "vercel.analytics.v2","eventType": "event","eventName": "button_click","eventData": "{\"button\": \"signup\"}","timestamp": 1694723405000,"projectId": "Qmc52npNy86S8VV4Mt8a8dP1LEkRNbgosW3pBCQytkcgf2","ownerId": "team_nLlpyC6REAqxydlFKbrMDlud","sessionId": 12345,"deviceId": 67890,"origin": "https://example.com","path": "/signup"}

Sampling Rate

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.

More resources

For more information on Web Analytics Drains and how to use them, refer to the following resources:

Previous
Speed Insights
Next
Security

Was this helpful?

supported.