# Run a lighthouse batch test

**POST /v1/lighthouse-batch-tests**

Runs a new lighthouse batch test.


## Servers
- https://api.speedvitals.com: https://api.speedvitals.com ()


## Authentication methods
- Api key


## Parameters



## Body parameters
Content-type: 
This is the lighthouse batch test body object
- **urls** (array[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.
- **devices** (array[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.
- **locations** (array[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.
- **batch_type** (string)
  The type of batch test to run
- **config** (object)
  

## Responses
### 201: A lighthouse batch report to be returned

#### Body Parameters:  (object)
- **id** (string)
  
- **urls** (array[string])
  
- **devices** (array[string])
  
- **locations** (array[string])
  
- **batch_type** (string)
  
- **config** (object)
  
- **status** (string)
  
- **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** (array[object])
  

### 400: Invalid Request body or missing required parameters

#### Body Parameters:  (object)
- **code** (string)
  An error code specific to the error.
- **message** (string)
  A human-readable message providing more details about the error.

### 402: Insufficient Credits

#### Body Parameters:  (object)
- **code** (string)
  An error code specific to the error.
- **message** (string)
  A human-readable message providing more details about the error.


[Powered by Bump.sh](https://bump.sh)