Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
lighthouse

Run Lighthouse audit on a website

post/lighthouse

Request body

urlstring required

Target URL

device'desktop' | 'mobile'

Device type to emulate. Defaults to desktop.

followRedirectboolean

Whether to follow redirects when checking site status

proxyCountrystring

Proxy country code to route the request

parametersstring[]

Extra Lighthouse CLI parameters

Example request

{
  "url": "https://example.com",
  "device": "desktop",
  "proxyCountry": "us",
  "parameters": [
    "--only-categories=seo"
  ]
}

Response

Successfully ran Lighthouse audit

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

datastring required

URL to the Lighthouse report

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "meta": {
    "url": "https://example.com",
    "redirectedURL": "https://example.com/",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  },
  "data": "https://example.com/report.html"
}