Body
This is the lighthouse test body object
-
url string
The url of webpage
-
device string
Values are
mobile
,desktop
,macbookAirM1
,highEndLaptop
,ipad102
,galaxyTabS7
,iphone13ProMax
,iphone11
,galaxyS10Plus
,redmiNote8Pro
,iphone7
,galaxyA50
,galaxyJ8
,motoG5
, orredmi5A
. -
location string
Values are
us
,ca
,br
,de
,uk
,nl
,pl
,ch
,jp
,in
,sg
,au
,id
,kr
, ortw
. -
config object
POST /v1/lighthouse-tests
curl \
-X POST https://api.speedvitals.com/v1/lighthouse-tests \
-H "X-API-KEY: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"value":{"url":"https://speedvitals.com","device":"macbookAirM1","location":"us","config":{"connection":"fiber","video":true,"adblock":true}}}'
Request example
{
"value": {
"url": "https://speedvitals.com",
"device": "macbookAirM1",
"location": "us",
"config": {
"connection": "fiber",
"video": true,
"adblock": true
}
}
}
Response example (201)
{
"value": {
"url": "https://speedvitals.com",
"device": "macbookAirM1",
"location": "us",
"config": {
"connection": "fiber",
"video": true,
"adblock": true
},
"status": "success",
"lighthouse_version": "9.6.2",
"metrics": null,
"report_url": null,
"created_at": 1657537268453,
"expires_at": 1660129268453,
"error": null
}
}
Response example (400)
{
"code": "string",
"message": "string"
}
Response example (402)
{
"code": "string",
"message": "string"
}