Skip to content

Latest commit

 

History

History
59 lines (54 loc) · 3.53 KB

updatecheckrequest.md

File metadata and controls

59 lines (54 loc) · 3.53 KB

UpdateCheckRequest

Example Usage

import { UpdateCheckRequest } from "@vercel/sdk/models/updatecheckop.js";

let value: UpdateCheckRequest = {
  deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
  checkId: "check_2qn7PZrx89yxY34vEZPD31Y9XVj6",
  teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
  slug: "my-team-url-slug",
  requestBody: {
    name: "Performance Check",
    path: "/",
    detailsUrl: "https://example.com/check/run/1234abc",
    output: {
      metrics: {
        fcp: {
          value: 1200,
          previousValue: 900,
          source: "web-vitals",
        },
        lcp: {
          value: 1200,
          previousValue: 1000,
          source: "web-vitals",
        },
        cls: {
          value: 4,
          previousValue: 2,
          source: "web-vitals",
        },
        tbt: {
          value: 3000,
          previousValue: 3500,
          source: "web-vitals",
        },
        virtualExperienceScore: {
          value: 30,
          previousValue: 35,
          source: "web-vitals",
        },
      },
    },
    externalId: "1234abc",
  },
};

Fields

Field Type Required Description Example
deploymentId string ✔️ The deployment to update the check for. dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
checkId string ✔️ The check being updated check_2qn7PZrx89yxY34vEZPD31Y9XVj6
teamId string ➖ The Team identifier to perform the request on behalf of. team_1a2b3c4d5e6f7g8h9i0j1k2l
slug string ➖ The Team slug to perform the request on behalf of. my-team-url-slug
requestBody models.UpdateCheckRequestBody ✔️ N/A