API Reference

Speed

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Pages

List tested webpages

client.Speed.Pages.List(ctx, query) (*SinglePage[PageListResponse], error)

GET/zones/{zone_id}/speed_api/pages

List core web vital metrics trend

client.Speed.Pages.Trend(ctx, url, params) (*Trend, error)

GET/zones/{zone_id}/speed_api/pages/{url}/trend

PagesTests

List page test history

client.Speed.Pages.Tests.List(ctx, url, params) (*V4PagePaginationArray[Test], error)

GET/zones/{zone_id}/speed_api/pages/{url}/tests

Get a page test result

client.Speed.Pages.Tests.Get(ctx, url, testID, query) (*Test, error)

GET/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}

Start page test

client.Speed.Pages.Tests.New(ctx, url, params) (*Test, error)

POST/zones/{zone_id}/speed_api/pages/{url}/tests

Delete all page tests

client.Speed.Pages.Tests.Delete(ctx, url, params) (*PageTestDeleteResponse, error)

DELETE/zones/{zone_id}/speed_api/pages/{url}/tests

ModelsExpand Collapse

type Test struct{…}

ID stringoptional

UUID.

maxLength36

Date Timeoptional

formatdate-time

DesktopReport LighthouseReportoptional

The Lighthouse report.

MobileReport LighthouseReportoptional

The Lighthouse report.

Region LabeledRegionoptional

A test region with a label.

ScheduleFrequency TestScheduleFrequencyoptional

The frequency of the test.

One of the following:

const TestScheduleFrequencyDaily TestScheduleFrequency = "DAILY"

const TestScheduleFrequencyWeekly TestScheduleFrequency = "WEEKLY"

URL stringoptional

A URL.