The Vercel Checks API let you create tests and assertions that run after each deployment has been built. They are powered by Integrations, which allow you to connect any third-party service of your choice with Vercel.
Once the Checks API start implementing on your deployment, its
status is set to
Updating the Check with a
conclusion will automatically set the Check
completed. This results in a successful deployment.
However, your deployment will fail if the
conclusion updates to one of the following values:
Vercel's Checks API is capable of generating rich output results that can store arbitrary data, Web Vitals and a Virtual Experience Score through the
To include Web Vitals and a Virtual Experience Score, the following can be passed to
output under a
The Total Blocking Time, as measured by the Check
The Largest Contentful Paint, as measured by the Check
The First Contentful Paint, as measured by the Check
The Cumulative Layout Shift, as measured by the Check
The overall Virtual Experience Score measured by the Check
Each of these has the following properties:
The value measured for the particular metric, in milliseconds. For virtualExperienceScore this value is the percentage between 0 and 1
A previous value for comparison purposes.