# Run a lighthouse test

**POST /v1/lighthouse-tests**

Runs a new lighthouse test.


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


## Authentication methods
- Api key


## Parameters



### Body:  (object)
This is the lighthouse test body object
- **url** (string)
  The url of webpage
- **device** (string)

- **location** (string)

- **config** (object)



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

#### Body:  (object)
- **id** (string)

- **url** (string)

- **device** (string)

- **location** (string)

- **config** (object)

- **status** (string)

- **lighthouse_version** (string)
  The version of the lighthouse used to generate the report
- **metrics** (object | null)

- **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 | null)
  Contains error code and description(present only if status is failed)

### 400
Invalid Request body or missing required parameters

#### Body:  (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:  (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)