Skip to main content

Get audit

Get the lighthouse audit for a project update.

Request​

GET or POST https://api.wattspeed.com/v1/audit

Headers
Authorization  string required

Your API token.

Parameters
url  string required

The project's URL - should be URL encoded.

date  string required

The UTC date and time of when a snapshot was generated - should be in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss.
Note: To use a date from the Snapshot view in Wattspeed, it may need to be converted to UTC from your local datetime.

device  string 

Use this to filter by device.
Allowed values: mobile, desktop.

location  array of strings 

Use this to filter by location. When passing multiple locations, include each location in a different parameter using the same name. Example: location=s_carolina&location=tokyo.
Allowed values: s_carolina, los_angeles, frankfurt, london, tokyo, sao_paulo.

Example request​

GET​

https://api.wattspeed.com/v1/audit?url=https://wattspeed.com&date=2022-08-01T00:37:21&location=s_carolina&location=london

POST​

{
  "url": "https://wattspeed.com",
  "date": "2022-08-01T00:37:21",
  "location": ["s_carolina", "london"]
}

Responses​

{
  "desktop": {
    "s_carolina": {
      "lighthouse": {
        ...LIGHTHOUSE_OBJECT,
        "crux": {
          "url": {
            ...CRUX_URL_OBJECT
          },
          "origin": {
            ...CRUX_ORIGIN_OBJECT
          }
        },
        "date": "2022-08-01T00:37:21",  // The UTC date and time for when the audit was generated
        "elementCount": 221  // The total number of HTML elements
      },
      "median": 1,
      "locations": [
        "s_carolina",
        "frankfurt"
      ],
      "defaultLocation": "s_carolina"
    }
  },
  "mobile": {
    "london": {
      "lighthouse": {
        ...LIGHTHOUSE_OBJECT,
        "crux": {
          "url": {
            ...CRUX_URL_OBJECT
          },
          "origin": {
            ...CRUX_ORIGIN_OBJECT
          }
        },
        "date": "2022-08-01T00:37:21",  // The UTC date and time for when the audit was generated
        "elementCount": 221  // The total number of HTML elements
      },
      "median": 1,
      "locations": [
        "london",
        "sao_paulo"
      ],
      "defaultLocation": "london"
    }
  }
}

More information on the actual properties of the lighthouse object can be found here. The CrUX object contains the CWV data for both URL and origin (if exists). The properties of the CrUX URL and origin objects can be found here.