Skip to content
Cloudflare API
Start here
API Reference
Speed

Pages

List tested webpages
client.speed.pages.list(PageListParams { zone_id } params, RequestOptionsoptions?): SinglePage<PageListResponse { region, scheduleFrequency, tests, url } >
GET/zones/{zone_id}/speed_api/pages
List core web vital metrics trend
client.speed.pages.trend(stringurl, PageTrendParams { zone_id, deviceType, metrics, 4 more } params, RequestOptionsoptions?): Trend { cls, fcp, lcp, 5 more }
GET/zones/{zone_id}/speed_api/pages/{url}/trend
ModelsExpand Collapse
PageListResponse { region, scheduleFrequency, tests, url }
region?: LabeledRegion { label, value }

A test region with a label.

scheduleFrequency?: "DAILY" | "WEEKLY"

The frequency of the test.

One of the following:
"DAILY"
"WEEKLY"
tests?: Array<Test { id, date, desktopReport, 4 more } >
id?: string

UUID.

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

The Lighthouse report.

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

The Lighthouse report.

region?: LabeledRegion { label, value }

A test region with a label.

scheduleFrequency?: "DAILY" | "WEEKLY"

The frequency of the test.

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

A URL.

url?: string

A URL.

PagesTests

List page test history
client.speed.pages.tests.list(stringurl, TestListParams { zone_id, page, per_page, region } params, RequestOptionsoptions?): V4PagePaginationArray<Test { id, date, desktopReport, 4 more } >
GET/zones/{zone_id}/speed_api/pages/{url}/tests
Get a page test result
client.speed.pages.tests.get(stringurl, stringtestId, TestGetParams { zone_id } params, RequestOptionsoptions?): Test { id, date, desktopReport, 4 more }
GET/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}
Start page test
client.speed.pages.tests.create(stringurl, TestCreateParams { zone_id, region } params, RequestOptionsoptions?): Test { id, date, desktopReport, 4 more }
POST/zones/{zone_id}/speed_api/pages/{url}/tests
Delete all page tests
client.speed.pages.tests.delete(stringurl, TestDeleteParams { zone_id, region } params, RequestOptionsoptions?): TestDeleteResponse { count }
DELETE/zones/{zone_id}/speed_api/pages/{url}/tests
ModelsExpand Collapse
Test { id, date, desktopReport, 4 more }
id?: string

UUID.

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

The Lighthouse report.

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

The Lighthouse report.

region?: LabeledRegion { label, value }

A test region with a label.

scheduleFrequency?: "DAILY" | "WEEKLY"

The frequency of the test.

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

A URL.

TestDeleteResponse { count }
count?: number

Number of items affected.