Skip to content
Start here

Pages

List tested webpages
GET/zones/{zone_id}/speed_api/pages
List core web vital metrics trend
GET/zones/{zone_id}/speed_api/pages/{url}/trend
ModelsExpand Collapse
PageListResponse = object { region, scheduleFrequency, tests, url }
region: optional LabeledRegion { label, value }

A test region with a label.

scheduleFrequency: optional "DAILY" or "WEEKLY"

The frequency of the test.

One of the following:
"DAILY"
"WEEKLY"
tests: optional array of Test { id, date, desktopReport, 4 more }
id: optional string

UUID.

maxLength36
date: optional string
formatdate-time
desktopReport: optional LighthouseReport { cls, deviceType, error, 9 more }

The Lighthouse report.

mobileReport: optional LighthouseReport { cls, deviceType, error, 9 more }

The Lighthouse report.

region: optional LabeledRegion { label, value }

A test region with a label.

scheduleFrequency: optional "DAILY" or "WEEKLY"

The frequency of the test.

One of the following:
"DAILY"
"WEEKLY"
url: optional string

A URL.

url: optional string

A URL.

PagesTests

List page test history
GET/zones/{zone_id}/speed_api/pages/{url}/tests
Get a page test result
GET/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}
Start page test
POST/zones/{zone_id}/speed_api/pages/{url}/tests
Delete all page tests
DELETE/zones/{zone_id}/speed_api/pages/{url}/tests
ModelsExpand Collapse
Test = object { id, date, desktopReport, 4 more }
id: optional string

UUID.

maxLength36
date: optional string
formatdate-time
desktopReport: optional LighthouseReport { cls, deviceType, error, 9 more }

The Lighthouse report.

mobileReport: optional LighthouseReport { cls, deviceType, error, 9 more }

The Lighthouse report.

region: optional LabeledRegion { label, value }

A test region with a label.

scheduleFrequency: optional "DAILY" or "WEEKLY"

The frequency of the test.

One of the following:
"DAILY"
"WEEKLY"
url: optional string

A URL.

TestDeleteResponse = object { count }
count: optional number

Number of items affected.