Skip to main content
POST
/
v1
/
lighthouse-batch-tests
Run a lighthouse batch test
curl --request POST \
  --url https://api.speedvitals.com/v1/lighthouse-batch-tests \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "urls": [
    "https://speedvitals.com",
    "https://blog.speedvitals.com"
  ],
  "devices": [
    "macbookAirM1"
  ],
  "locations": [
    "us"
  ],
  "batch_type": "multiple-urls"
}
'
{
  "id": "lbt_IU8rN0XQmIWEqGkP",
  "urls": [
    "https://speedvitals.com",
    "https://blog.speedvitals.com"
  ],
  "devices": [
    "macbookAirM1"
  ],
  "locations": [
    "us"
  ],
  "batch_type": "multiple-urls",
  "status": "idle",
  "lighthouse_version": "9.6.2",
  "report_url": "https://speedvitals.com/result/afd98w0l/",
  "created_at": 1657539924734,
  "expires_at": 1660131924733,
  "reports": [
    {
      "id": "lt_dObdG5EW4d231hto",
      "url": "https://speedvitals.com",
      "device": "macbookAirM1",
      "location": "us",
      "status": "success",
      "metrics": {
        "cumulative_layout_shift": 0,
        "first_contentful_paint": 292,
        "first_meaningful_paint": 297,
        "time_to_interactive": 297,
        "largest_contentful_paint": 434,
        "server_response_time": 32,
        "speed_index": 900,
        "total_blocking_time": 0,
        "performance_score": 100
      },
      "report_url": "https://speedvitals.com/report/speedvitals.com/IvWenx/",
      "error": null
    },
    {
      "id": "lt_dmpbeQ2xk1XPh4UP",
      "url": "https://blog.speedvitals.com",
      "device": "macbookAirM1",
      "location": "us",
      "status": "idle",
      "metrics": {
        "cumulative_layout_shift": 0,
        "first_contentful_paint": 322,
        "first_meaningful_paint": 365,
        "time_to_interactive": 368,
        "largest_contentful_paint": 488,
        "server_response_time": 68,
        "speed_index": 1406,
        "total_blocking_time": 0,
        "performance_score": 99
      },
      "report_url": "https://speedvitals.com/report/blog.speedvitals.com/3t4lm7",
      "error": null
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

This is the lighthouse batch test body object

​
urls
string[]

For multiple-urls batch type, provide an array of urls to test. For other batch types, provide a single url in array and if multiple urls are provided, only first in the list will be used for the test. All invalid urls in the array will be ignored.

Maximum string length: 5000
​
devices
enum<string>[]

For multiple-devices batch type, provide an array of device ids to test or leave it empty for testing on all preset devices. For other batch types, provide a single device id in array and if multiple device ids are provided, only first in the list will be used for the test. All invalid device ids in the array will be ignored.

Available options:
mobile,
desktop,
macbookAirM1,
highEndLaptop,
ipad102,
galaxyTabS7,
iphone13ProMax,
iphone11,
galaxyS10Plus,
redmiNote8Pro,
iphone7,
galaxyA50,
galaxyJ8,
motoG5,
redmi5A
Maximum string length: 5000
​
locations
enum<string>[]

For multiple-locations batch type, provide an array of location ids to test or leave it empty for testing on all preset locations. For other batch types, provide just a single location id in array and if multiple location ids are provided, only first in the list will be used for the test. All invalid location ids in the array will be ignored.

Available options:
us,
ca,
br,
de,
uk,
nl,
pl,
ch,
jp,
in,
sg,
au,
id,
kr,
tw
Maximum string length: 5000
​
batch_type
enum<string>

The type of batch test to run

Available options:
multiple-urls,
multiple-devices,
multiple-locations
​
config
object

Response

A lighthouse batch report to be returned

​
urls
string[]
required
​
devices
enum<string>[]
required
Available options:
mobile,
desktop,
macbookAirM1,
highEndLaptop,
ipad102,
galaxyTabS7,
iphone13ProMax,
iphone11,
galaxyS10Plus,
redmiNote8Pro,
iphone7,
galaxyA50,
galaxyJ8,
motoG5,
redmi5A
​
locations
enum<string>[]
required
Available options:
us,
ca,
br,
de,
uk,
nl,
pl,
ch,
jp,
in,
sg,
au,
id,
kr,
tw
​
batch_type
enum<string>
required
Available options:
multiple-urls,
multiple-devices,
multiple-locations
​
id
string
​
config
object
​
status
enum<string>
Available options:
idle,
active,
completed
​
lighthouse_version
string

The version of the lighthouse used to run the tests

​
report_url
string
​
created_at
number

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

​
expires_at
number

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

​
reports
object[]