Skip to main content
POST
Run Lighthouse audit on a website

Authorizations

x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
url
string
required

Target URL

Example:

"https://example.com"

device
enum<string>
default:desktop

Device type to emulate. Defaults to desktop.

Available options:
desktop,
mobile
Example:

"desktop"

followRedirect
boolean
default:false

Whether to follow redirects when checking site status

Example:

false

proxyCountry
string

Proxy country code to route the request

Example:

"us"

parameters
string[]

Extra Lighthouse CLI parameters

Example:

Response

Successfully ran Lighthouse audit

timestamp
number
required

Timestamp of the request in milliseconds

Example:

1783943217189

apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

apiCode
number
required

API status code

Example:

200

meta
object
required

Metadata about the request

data
string
required

URL to the Lighthouse report

Example:

"https://example.com/report.html"