Web Analytics

Explore traffic and custom events for projects with Web Analytics enabled. You can count page views and events or aggregate them to understand how visitors use your application.

`aggregate_events`

Aggregates custom events.

Enable Web Analytics for your project before querying its data.

Parameters

Parameter	Type	Required	Description
`projectId`	string	Yes	The project identifier or the project name
`by`	Array<string \| unknown>	Yes	Up to two dimensions used to break down results. At most one time granularity is allowed: hour, day, week, month, year. Other dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions: flags, eventData. Used bare, they break down results by key, for example flags returns one group per flag name. With a key, they break down results by that key's value, for example eventData/plan. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag'.
`since`	number \| string	Yes	Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
`until`	number \| string	Yes	Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
`limit`	integer	No	Number of distinct results, default to 10. Other results are grouped into "Others" group. Default: `10`.
`filter`	string	No	OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. By default, filters for production environment only. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions filtered by key: flags/<name>, eventData/<property>, for example eventData/plan eq 'pro'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
`teamId`	string	No	Team ID.
`slug`	string	No	Team slug.

`aggregate_pageviews`

Aggregates page views.

Enable Web Analytics for your project before querying its data.

Parameters

Parameter	Type	Required	Description
`projectId`	string	Yes	The project identifier or the project name
`by`	Array<string \| unknown>	Yes	Up to two dimensions used to break down results. At most one time granularity is allowed: hour, day, week, month, year. Other dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm. JSON dimensions: flags. Used bare, it breaks down results by key, for example flags returns one group per flag name. With a key, it breaks down results by that key's value, for example flags/beta_banner. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag'.
`since`	number \| string	Yes	Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
`until`	number \| string	Yes	Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
`limit`	integer	No	Number of distinct results, default to 10. Other results are grouped into "Others" group. Default: `10`.
`filter`	string	No	OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. By default, filters for production environment only. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm. JSON dimensions filtered by key: flags/<name>, for example flags/beta_banner eq 'true'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
`teamId`	string	No	Team ID.
`slug`	string	No	Team slug.

`count_events`

Counts custom events.

Enable Web Analytics for your project before querying its data.

Parameters

Parameter	Type	Required	Description
`projectId`	string	Yes	The project identifier or the project name
`since`	number \| string	No	Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
`until`	number \| string	No	Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
`filter`	string	No	OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, eventName. JSON dimensions filtered by key: flags/<name>, eventData/<property>, for example eventData/plan eq 'pro'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
`teamId`	string	No	Team ID.
`slug`	string	No	Team slug.

`count_pageviews`

Counts page views.

Enable Web Analytics for your project before querying its data.

Parameters

Parameter	Type	Required	Description
`projectId`	string	Yes	The project identifier or the project name
`since`	number \| string	No	Timestamp in milliseconds, or a valid Date string. Selects data from (including) this date and time. Will be adjusted according to the desired time granularity.
`until`	number \| string	No	Timestamp in milliseconds, or a valid Date string. Selects data until (including) this date. Will be adjusted according to the desired time granularity.
`filter`	string	No	OData-compliant filter. Encode the value when sending it in a URL. Allows filtering on one or multiple dimensions. Supported dimensions: country, deviceType, environment, requestPath, referrerHostname, osName, browserName, route, utmSource, utmMedium, utmCampaign, utmContent, utmTerm. JSON dimensions filtered by key: flags/<name>, for example flags/beta_banner eq 'true'. Wrap keys containing characters other than letters, digits, and underscores in single quotes, for example flags/'my-flag' eq 'true'. Supported operations include eq, ne, in, and logical operators and, or, not with parentheses. Functions such as startswith are supported by the OData parser.
`teamId`	string	No	Team ID.
`slug`	string	No	Team slug.

Cross-link map: Web Analytics (/docs/agent-resources/vercel-mcp/tools/web-analytics)

From the Vercel docs graph (built 2026-10-06T09:42:32.185Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

aggregate_events — Use aggregate_events with Vercel MCP.
aggregate_pageviews — Use aggregate_pageviews with Vercel MCP.
count_events — Use count_events with Vercel MCP.
count_pageviews — Use count_pageviews with Vercel MCP.
Counts custom events — GET /v1/query/web-analytics/events/count — Counts the number of custom events on a project \(production only\), since We

Prerequisites

Agent Resources — Set up AI coding tools with Vercel documentation, reusable skills, and secure access to projects, deployments, and logs.

This page links to (1)

Vercel Web Analytics — With Web Analytics, you can get detailed insights into your website's visitors with new metrics like top pages, top refe

Toolbar

aggregate_events

Was this helpful?