GET
/
v1
/
deployments
/
{deploymentId}
/
checks
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.checks.getAllChecks({
    deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "checks": [
    {
      "completedAt": 123,
      "conclusion": "canceled",
      "createdAt": 123,
      "detailsUrl": "<string>",
      "id": "<string>",
      "integrationId": "<string>",
      "name": "<string>",
      "output": {
        "metrics": {
          "FCP": {
            "value": 123,
            "previousValue": 123,
            "source": "web-vitals"
          },
          "LCP": {
            "value": 123,
            "previousValue": 123,
            "source": "web-vitals"
          },
          "CLS": {
            "value": 123,
            "previousValue": 123,
            "source": "web-vitals"
          },
          "TBT": {
            "value": 123,
            "previousValue": 123,
            "source": "web-vitals"
          },
          "virtualExperienceScore": {
            "value": 123,
            "previousValue": 123,
            "source": "web-vitals"
          }
        }
      },
      "path": "<string>",
      "rerequestable": true,
      "startedAt": 123,
      "status": "registered",
      "updatedAt": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
deploymentId
string
required

The deployment to get all checks for

Example:

"dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200
application/json
​
checks
object[]
required