vercel metrics

The vercel metrics command, also available as vc metrics, lets you discover and query metrics from the command line. Querying observability metrics requires Observability Plus, with product-specific exceptions listed below.

Metrics other than Web Analytics and Speed Insights metrics are available on Enterprise and Pro plans with Observability Plus

Use vercel metrics schema before you build a query. Without an argument, the command lists the metrics available to your account. Pass a metric ID or prefix to inspect its dimensions and aggregations.

Usage

terminal

# List queryable metrics for the current team context
vercel metrics schema
 
# Inspect a metric or metric prefix
vercel metrics schema <metric-or-prefix>
 
# Query a custom metric and filter by an attribute
vercel metrics database.duration_ms --filter 'plan:pro'
 
# Query production data for a specific project
vercel metrics <metric-id> --since 7d --granularity 1d --project project-name --prod
 
# Query grouped results
vercel metrics <metric-id> --group-by <dimension> --since 1d --limit 5 --project project-name --prod
 
# Query across every project in the current team
vercel metrics <metric-id> --all --group-by projectId --since 24h --prod

Using the vercel metrics command to discover metrics before querying them.

Query output

By default, vercel metrics prints a human-readable table or time series summary. Use --format to output structured JSON for scripts, agents, and continuous integration checks.

Feature access

Web Analytics metrics are available through vercel metrics without Observability Plus.

Speed Insights metrics are available through vercel metrics without Observability Plus.

Metrics other than Web Analytics and Speed Insights metrics require Observability Plus.

The dashboard and CLI are complementary:

Use product dashboards for curated views.
Use vercel metrics for custom filtering, grouping, aggregations, JSON output, and agent workflows.
Use --all to query across every project in the current team when you need team-wide comparisons.

Unique options

These options only apply to the vercel metrics command.

Metric

The <metric-id> positional argument specifies the metric to query. Run vercel metrics schema to list queryable metrics for the current team context.

terminal

vercel metrics <metric-id>
vercel metrics schema

Schema subcommand

Use the schema subcommand to inspect the dimensions and aggregations available for a metric. Pass a metric ID or prefix to inspect a narrower part of the schema.

terminal

vercel metrics schema
vercel metrics schema <metric-or-prefix>

Use --format when you are building scripts or agent workflows that need to validate available fields before querying.

Aggregation

The --aggregation option, shorthand -a, selects the aggregation for the metric.

terminal

vercel metrics <metric-id> --aggregation <aggregation>

If omitted, the CLI selects a supported aggregation based on the metric's unit. Use vercel metrics schema <metric-or-prefix> to inspect the available aggregations.

Group-by

The --group-by option groups results by a dimension. Repeat it to group by multiple dimensions.

terminal

vercel metrics <metric-id> --group-by <dimension>
vercel metrics <metric-id> --group-by <dimension> --group-by <dimension>

Filter

The --filter option, shorthand -f, filters the query using Vercel's supported subset of Kibana Query Language (KQL). For custom metrics, use <attribute>:<value> to filter by an attribute:

terminal

vercel metrics database.duration_ms --filter 'plan:pro'

For platform metrics, use a dimension from the metric schema:

terminal

vercel metrics <metric-id> --filter 'environment:production'
vercel metrics <metric-id> --filter 'httpStatus >= 500'
vercel metrics <metric-id> --filter 'requestPath:(/docs* OR /guides*)'

The following KQL syntax is supported:

Syntax	Description	Example
`field:value`, `field = value`, or `field == value`	Match a value. Values are interpreted using the dimension's type.	`environment:production`
`field != value`, `field > value`, `field >= value`, `field < value`, or `field <= value`	Exclude a value or compare numeric dimensions.	`httpStatus >= 500`
`field:(value1 OR value2)`	Match any of several values for one dimension.	`country:(US OR DE)`
`field:`, `field=`, or `field==*`	Match data where the dimension exists.	`errorCode:*`
`field:prefix`, `field:suffix`, or `field:text`	Match a string by prefix, suffix, or substring.	`requestPath:/api/*`
`field =~ "pattern"`	Match a string using a regular expression. The pattern must be double-quoted.	`requestPath =~ "^/api/(v1\|v2)/"`
`AND`, `OR`, `NOT`, or `-expression`	Combine or negate expressions. Adjacent expressions imply `AND`.	`environment:production AND NOT country:US`
`(expression)`	Control how expressions are grouped.	`(country:US OR country:DE) AND deviceType:mobile`

Wrap the complete filter in single quotes in your shell. Double-quote values that contain spaces or KQL-reserved characters. Use a backslash to escape the next character in a quoted or unquoted value:

terminal

vercel metrics <metric-id> --filter 'requestPath:"/pricing enterprise"'

Repeat --filter to combine filters with AND:

terminal

vercel metrics <metric-id> -f 'country:US' -f 'deviceType != mobile'

The filter implementation is KQL-inspired and does not support every KQL feature. The following limits apply:

Filter dimensions must be available to the selected metric. Run vercel metrics schema <metric-or-prefix> to inspect them.
Numeric dimensions require finite numeric values, and boolean dimensions require true or false.
Wildcards and regular expressions require string dimensions. Wildcards are only supported at the beginning or end of a value; infix patterns such as i*d are rejected.
Bare quoted phrases and unfielded wildcard searches are not supported.
KQL nested-object syntax and Lucene fuzzy, proximity, and boosting operators are not supported.
Each filter can contain up to 2,048 characters and 8 levels of nesting. A query can contain up to 50 expression nodes across all filters.

OData filter syntax is deprecated. Use KQL for new queries.

Production environment

The --prod option limits the query to production data. It is equivalent to --filter 'environment:production'.

terminal

vercel metrics <metric-id> --prod

Since

The --since option, shorthand -s, sets the start of the time range. You can use a relative duration like 1h, 24h, or 7d, a date, or an ISO timestamp. If omitted, the CLI defaults to the last hour.

terminal

vercel metrics <metric-id> --since 24h

Until

The --until option, shorthand -u, sets the end of the time range. If omitted, the command uses the current time.

terminal

vercel metrics <metric-id> --since 24h --until 2026-03-19T12:00:00Z

Granularity

The --granularity option, shorthand -g, controls the time bucket size. If omitted, the CLI computes a granularity for the selected time range.

terminal

vercel metrics <metric-id> --granularity 1h --since 7d

Limit

The --limit option, shorthand -l, sets the maximum number of grouped results returned per time bucket. The default is 10.

terminal

vercel metrics <metric-id> --group-by <dimension> --limit 50

Order by

The --order-by option only applies to grouped results, so use it with --group-by. The default is count when the metric supports counting data points and value otherwise. Use --order-by value to order groups by the actual metric value returned by the query.

terminal

vercel metrics <metric-id> --group-by <dimension> --order-by count
vercel metrics <metric-id> --group-by <dimension> --order-by value

Order

The --order option sets the ordering direction for grouped results. It accepts asc or desc. The default is desc.

terminal

vercel metrics <metric-id> --group-by <dimension> --order-by value --order asc

Project

The --project option, shorthand -p, specifies the project name or project ID to query. Use it when you want results for a specific project. It defaults to the linked project when --all is not set.

terminal

vercel metrics <metric-id> --project project-name --prod

All

The --all option queries across all projects in the current team scope. It cannot be combined with --project.

terminal

vercel metrics <metric-id> --all --group-by projectId --prod

Format

The --format option outputs JSON instead of text. Use it for automation and agents.

terminal

vercel metrics <metric-id> --format json
vercel metrics schema <metric-or-prefix> --format json

Examples

Inspect the schema before building a query:

terminal

vercel metrics schema <metric-or-prefix>

List all available metrics:

terminal

vercel metrics schema

Query a custom metric for the pro plan:

terminal

vercel metrics database.duration_ms --filter 'plan:pro'

Query a metric for the last seven days:

terminal

vercel metrics <metric-id> --since 7d --granularity 1d --project project-name --prod

Query grouped results for a specific project:

terminal

vercel metrics <metric-id> --group-by <dimension> --since 24h --project project-name --prod

Query production data across every project in the current team:

terminal

vercel metrics <metric-id> --all --group-by projectId --since 24h --prod

Global Options

The following global options can be passed when using the vercel metrics command:

For more information on global options and their usage, refer to the options section.

Last updated August 19, 2026

Cross-link map: vercel metrics (/docs/cli/metrics)

From the Vercel docs graph (built 2026-09-15T06:10:09.927Z), 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

Accessing Metrics with Vercel CLI — Use the Vercel CLI to query Web Analytics metrics from your terminal.
Accessing Metrics with Vercel CLI — Use the Vercel CLI to query Speed Insights metrics from your terminal.
vercel list — Learn how to list out all recent deployments for the current Vercel Project using the vercel list CLI command.
vercel logs — View and filter request logs for your Vercel project, or stream live runtime logs from a deployment.
vercel usage — Learn how to view billing usage and costs, for your Vercel account using the vercel usage CLI command.

This page links to (2)

Vercel CLI Global Options — Global options are commonly available to use with multiple Vercel CLI commands. Learn about Vercel CLI's global options
Observability Plus — Learn about using Observability Plus and its limits.

Pages that link here (6)

By site: vercel-changelog (1) · vercel-kb (1) · vercel-docs (4)

From vercel-changelog

Query observability metrics using the Vercel CLI

From vercel-kb

Improve Cumulative Layout Shift \(CLS\) on Vercel — Read, diagnose, and fix Cumulative Layout Shift on Vercel using Speed Insights and Next.js best practices.

From vercel-docs

Accessing Metrics with Vercel CLI — Use the Vercel CLI to query Web Analytics metrics from your terminal.
Vercel CLI Overview — Learn how to use the Vercel command-line interface \(CLI\) to manage and configure your Vercel Projects from the command
Emit Custom Metrics from Vercel Functions — Learn how to emit application-specific metrics from Vercel Functions and analyze them in Observability.
Accessing Metrics with Vercel CLI — Use the Vercel CLI to query Speed Insights metrics from your terminal.

vercel mcp

vercel microfrontends

Was this helpful?

Build with AI

Deploy & scale

Operate & protect

Resources

vercel metrics

Usage

Query output

Feature access

Unique options

Metric

Schema subcommand

Aggregation

Group-by

Filter

Production environment

Since

Until

Granularity

Limit

Order by

Order

Project

All

Format

Examples

Global Options

Cross-link map: vercel metrics (/docs/cli/metrics)

Semantically closest pages

This page links to (2)

Pages that link here (6)

From vercel-changelog

From vercel-kb

From vercel-docs

Cross-link map: vercel metrics (/docs/cli/metrics)

Semantically closest pages

This page links to (2)

Pages that link here (6)

From vercel-changelog

From vercel-kb

From vercel-docs