Checks

Checks allow you to test a specific URL in one or many regions. For each specified region you'll get a unique run that contains the result for the corresponding region

Get Check

Get a specific check.

Path Parameters

checkId
required

The id of the check

GET
/v1/checks/:checkId
Response
{
  "id": "0be76dba-2bbe-4a8b-9134-7451a265adee",
  "lighthouseVersion": "9.0.0",
  "url": "https://www.example.com",
  "regions": [
    "us-west1"
  ],
  "runs": [
    {
      "id": "41f1089d-454a-4a84-890d-db5986d7e911",
      "lighthouseVersion": "9.0.0",
      "url": "https://www.example.com",
      "region": "us-west1",
      "state": "succeeded",
      "performance": 100,
      "accessibility": 92,
      "bestPractices": 100,
      "pwa": 30,
      "seo": 91,
      "fcp": "788ms",
      "si": "788ms",
      "lcp": "788ms",
      "tti": "788ms",
      "tbt": "0ms",
      "cls": 0,
      "createdAt": "2022-01-11T13:43:45.536Z",
      "updatedAt": "2022-01-11T13:43:45.536Z"
    }
  ]
}

Create Check

Create a check for a specific url.

Body Parameters

url
required

The url to test, starting with http:// or https://

lighthouseVersion
required

The Lighthouse version that should be used

regions
required

Regions where the check should run. At least one region is required

Available regions:
us-west1, us-east4, europe-north1, europe-west3,
asia-northeast1, australia-southeast1

POST
/v1/checks
Body
{
  "url": "https://www.example.com",
  "lighthouseVersion": "9.0.0",
  "regions": [
    "us-west1"
  ]
}
Response
{
  "id": "0be76dba-2bbe-4a8b-9134-7451a265adee",
  "lighthouseVersion": "9.0.0",
  "url": "https://www.example.com",
  "regions": [
    "us-west1"
  ],
  "runs": [
    {
      "id": "41f1089d-454a-4a84-890d-db5986d7e911",
      "region": "us-west1",
      "state": "created"
    }
  ]
}