vercel metrics

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

Use vercel metrics list before you build a query. The command lists all metrics available to your account. Use vercel metrics schema to inspect the dimensions and aggregations for a metric.

# List queryable metrics for the current team context
vercel metrics list
 
# 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 project_id --since 24h --prod

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.

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, calendar buckets, JSON output, and agent workflows.
• Use --all to query across every project in the current team when you need team-wide comparisons.

These options only apply to the vercel metrics command.

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

vercel metrics <metric-id>
vercel metrics list

Use the list subcommand to list all metrics available to your account:

vercel metrics list

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.

vercel metrics schema <metric-or-prefix>

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

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

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

If omitted, the CLI uses the default aggregation from the metric schema.

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

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

The --filter option, shorthand -f, filters the query. For custom metrics, use <attribute>:<value> to filter by an attribute:

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

For other metrics, pass an OData filter expression. Repeat the option to combine filters with and:

vercel metrics <metric-id> --filter "<dimension> eq '<value>'"
vercel metrics <metric-id> -f "<dimension> eq '<value>'" -f "<dimension> ne '<value>'"

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

vercel metrics <metric-id> --prod

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.

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

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

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

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

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

The --bucket-timezone option sets an IANA timezone for calendar bucket alignment. It does not shift --since, --until, or output timestamps.

vercel metrics <metric-id> --since 2026-05-28 --until 2026-05-29 --granularity 1d --bucket-timezone Europe/Paris

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

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

The --order-by option only applies to grouped results, so use it with --group-by. The default is count, which orders groups by the number of data points. Use --order-by value to order groups by the actual metric value returned by the query.

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

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

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

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.

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

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

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

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

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

Inspect the schema before building a query:

vercel metrics schema <metric-or-prefix>

List all available metrics:

vercel metrics list

Query a custom metric for the pro plan:

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

Query a metric for the last seven days:

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

Query grouped results for a specific project:

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

Query production data across every project in the current team:

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

Align daily buckets to a calendar timezone:

vercel metrics <metric-id> --since 2026-05-28 --until 2026-05-29 --granularity 1d --bucket-timezone Europe/Paris --project project-name --prod

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

• --cwd
• --debug
• --global-config
• --help
• --local-config
• --no-color
• --non-interactive
• --scope
• --team
• --token
• --version

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