For AI agents: a documentation index is available at /llms.txt
Skip to main content

/chromium/performance

POST 

/chromium/performance

Run lighthouse performance audits with a supplied "url" in your JSON payload.

Note: Also available at /performance as a convenience alias.

Request​

Query Parameters

    blockAds boolean
    blockAdsInclude string
    launch object
    profile string
    timeout number
    token string
    trackingId string
    allowedDomains string[]
    credentials object
    externalProxyServer string
    integrationId string
    proxy ProxyType

    Possible values: [datacenter, residential]

    proxyCity string
    proxyCountry string
    proxyLocaleMatch string

    Possible values: [0, 1, false, true]

    proxyPreset string
    proxyState string
    proxySticky string

    Possible values: [0, 1, false, true]

Body

    budgets object[]
  • Array [
  • object
    property name*any
  • ]
  • config object
    object
    property name*any
    urlstringrequired

Responses​

The response of the lighthouse stats. Response objects are determined by the type of budgets and config in the POST JSON body

Schema
No schema
Was this page helpful?