Skip to main content
POST
Run a Core Web Vitals check

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

project_id
string<uuid>
required

Body

application/json

Request body to trigger a Web Vitals check.

url
string
required

URL to check.

device
string
default:mobile

'mobile' or 'desktop'.

refresh_id
string<uuid> | null

If provided, resets the existing check instead of creating a new one.

Response

Successful Response

success
boolean
default:true
data
WebVitalsCheckResponse · object | null

Full Web Vitals check result.