Documentation Plugins Vercel data source Query editor

Vercel query editor

This document explains how to use the Vercel query editor to query resources from the Vercel REST API.

Before you begin

Before you build a query, ensure you have configured the Vercel data source and that your access token has permission to read the resources you want to query.

Key concepts

If you’re new to Vercel, this document uses the following terms:

Build a query

Each query targets a single Vercel REST API resource, which you select with the Action field.

1. In a panel or in Explore, select your Vercel data source.
2. Select an action from the Action field.
3. Enter any required parameters, such as a deployment or drain identifier.
4. Expand Additional Parameters to set optional query parameters.
5. Run the query.

Some parameters populate their values from a drop-down. For example, when you select an action that requires a deployment_id, the editor loads the available deployments so you can pick one instead of entering an ID manually.

Actions

The query editor supports the following actions, grouped by resource category.

Common parameters

Many actions share the following parameters. The query editor hides time range and limit parameters by default; they appear under Additional Parameters.

Actions that target a specific resource include a required path parameter, such as deployment_id, idOrName, id, tokenId, or webhook_id. The editor populates these from a drop-down using a related list action, so you can select a resource instead of entering its identifier.

Action-specific parameters

Some actions expose additional parameters and filters.

List deployments

The List deployments action supports these filters, in addition to the common parameters:

Get deployment events

The Get deployment events action supports a direction parameter with the values backward or forward, along with builds, delimiter, and follow flags.

Check the price for a domain

The Check the price for a domain action requires a domain name and supports a type parameter with the values new, renewal, transfer, or redemption.

Read active attack data

The Read active attack data action requires a projectId and returns active attack data from the last 24-hour window.

Query examples

The following examples show how to configure common queries. Each example assumes you’ve selected your Vercel data source in a panel.

List failed deployments for a project

Use this query to build a table of deployments that failed to build.

1. Select List deployments from the Action field.
2. Expand Additional Parameters.
3. Set projectId to your project ID or name.
4. Set state to ERROR.
5. Run the query, then set the panel visualization to Table.

The since and until parameters default to the dashboard time range, so the table follows the selected time window.

Chart deployment frequency over time

Use this query to visualize how often you deploy.

1. Select List deployments from the Action field.
2. Optionally expand Additional Parameters and set target to an environment, such as production.
3. Run the query, then set the panel visualization to Table or a time-based visualization.
4. Use the parsed created time field to group or graph deployments by time.

Monitor firewall attack activity

Use this query to surface active attacks on a project.

1. Select Read active attack data from the Action field.
2. Set the required projectId.
3. Run the query, then set the panel visualization to Stat or Table.

Audit registered domains

Use this query to list the domains registered for your account or team.

1. Select List all the domains from the Action field.
2. Run the query, then set the panel visualization to Table.
3. Use the parsed createdAt and boughtAt time fields to track domain age.

Use cases

The Vercel data source supports scenarios such as:

• Deployment monitoring: Track deployment status and frequency, and alert on failed builds with the List deployments action filtered by state.
• Security monitoring: Watch firewall activity across projects with the Read active attack data action.
• Domain management: Audit registered domains and their purchase dates with the List all the domains action.
• Log drain oversight: Confirm which log drains are configured for your account or team with the Retrieves a list of all the Log Drains action.

Next steps

• Use template variables
• Troubleshoot the Vercel data source