Skip to main content
GET
/
v1
/
lighthouse-tests
/
{id}
Retrieve a lighthouse report
curl --request GET \
  --url https://api.speedvitals.com/v1/lighthouse-tests/{id} \
  --header 'X-API-KEY: <api-key>'
{
  "id": "lt_LthsZedDcOUfYFHxN",
  "url": "https://speedvitals.com",
  "device": "macbookAirM1",
  "location": "us",
  "config": {
    "http_version": "2",
    "video": true,
    "adblock": true
  },
  "status": "idle",
  "lighthouse_version": "9.6.2",
  "metrics": {
    "cumulative_layout_shift": 0,
    "first_contentful_paint": 515,
    "first_meaningful_paint": 566,
    "time_to_interactive": 725,
    "largest_contentful_paint": 515,
    "server_response_time": 21,
    "speed_index": 1123,
    "total_blocking_time": 69,
    "performance_score": 99
  },
  "report_url": "https://speedvitals.com/report/speedvitals.com/Q6qWx6/",
  "created_at": 1657537268453,
  "expires_at": 1660129268453,
  "error": null
}

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
id
string
required
Maximum string length: 5000
Example:

"lt_LthsZedDcOUfYFHxN"

Response

Successful response.

​
url
string
required
​
device
enum<string>
required
Available options:
mobile,
desktop,
macbookAirM1,
highEndLaptop,
ipad102,
galaxyTabS7,
iphone13ProMax,
iphone11,
galaxyS10Plus,
redmiNote8Pro,
iphone7,
galaxyA50,
galaxyJ8,
motoG5,
redmi5A
Example:

"macbookAirM1"

​
location
enum<string>
required
Available options:
us,
ca,
br,
de,
uk,
nl,
pl,
ch,
jp,
in,
sg,
au,
id,
kr,
tw
Example:

"us"

​
status
enum<string>
required
Available options:
idle,
active,
success,
failed
​
lighthouse_version
string
required

The version of the lighthouse used to generate the report

​
id
string
​
config
object
​
metrics
object
​
report_url
string | null

The URL at which SpeedVitals report is accessible (Present when status is success)

​
created_at
number

Time at which the test was created. Measured in seconds since the Unix epoch.

​
expires_at
number

Time at which the report will expire. Measured in seconds since the Unix epoch.

​
error
object

Contains error code and description(present only if status is failed)