API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Speed

ModelsExpand Collapse

type LabeledRegion struct{…}

A test region with a label.

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

type LighthouseReport struct{…}

The Lighthouse report.

CLS float64optional

Cumulative Layout Shift.

DeviceType LighthouseReportDeviceTypeoptional

The type of device.

One of the following:

const LighthouseReportDeviceTypeDesktop LighthouseReportDeviceType = "DESKTOP"

const LighthouseReportDeviceTypeMobile LighthouseReportDeviceType = "MOBILE"

Error LighthouseReportErroroptional

Code LighthouseReportErrorCodeoptional

The error code of the Lighthouse result.

One of the following:

const LighthouseReportErrorCodeNotReachable LighthouseReportErrorCode = "NOT_REACHABLE"

const LighthouseReportErrorCodeDNSFailure LighthouseReportErrorCode = "DNS_FAILURE"

const LighthouseReportErrorCodeNotHTML LighthouseReportErrorCode = "NOT_HTML"

const LighthouseReportErrorCodeLighthouseTimeout LighthouseReportErrorCode = "LIGHTHOUSE_TIMEOUT"

const LighthouseReportErrorCodeUnknown LighthouseReportErrorCode = "UNKNOWN"

Detail stringoptional

Detailed error message.

FinalDisplayedURL stringoptional

The final URL displayed to the user.

FCP float64optional

First Contentful Paint.

JsonReportURL stringoptional

The URL to the full Lighthouse JSON report.

LCP float64optional

Largest Contentful Paint.

PerformanceScore float64optional

The Lighthouse performance score.

Si float64optional

Speed Index.

State LighthouseReportStateoptional

The state of the Lighthouse report.

One of the following:

const LighthouseReportStateRunning LighthouseReportState = "RUNNING"

const LighthouseReportStateComplete LighthouseReportState = "COMPLETE"

const LighthouseReportStateFailed LighthouseReportState = "FAILED"

TBT float64optional

Total Blocking Time.

TTFB float64optional

Time To First Byte.

TTI float64optional

Time To Interactive.

type Trend struct{…}

CLS []float64optional

Cumulative Layout Shift trend.

FCP []float64optional

First Contentful Paint trend.

LCP []float64optional

Largest Contentful Paint trend.

PerformanceScore []float64optional

The Lighthouse score trend.

Si []float64optional

Speed Index trend.

TBT []float64optional

Total Blocking Time trend.

TTFB []float64optional

Time To First Byte trend.

TTI []float64optional

Time To Interactive trend.

SpeedSchedule

Get a page test schedule

client.Speed.Schedule.Get(ctx, url, params) (*Schedule, error)

GET/zones/{zone_id}/speed_api/schedule/{url}

Create scheduled page test

client.Speed.Schedule.New(ctx, url, params) (*ScheduleNewResponse, error)

POST/zones/{zone_id}/speed_api/schedule/{url}

Delete scheduled page test

client.Speed.Schedule.Delete(ctx, url, params) (*ScheduleDeleteResponse, error)

DELETE/zones/{zone_id}/speed_api/schedule/{url}

ModelsExpand Collapse

type Schedule struct{…}

The test schedule.

Frequency ScheduleFrequencyoptional

The frequency of the test.

One of the following:

const ScheduleFrequencyDaily ScheduleFrequency = "DAILY"

const ScheduleFrequencyWeekly ScheduleFrequency = "WEEKLY"

Region ScheduleRegionoptional

A test region.

One of the following:

const ScheduleRegionAsiaEast1 ScheduleRegion = "asia-east1"

const ScheduleRegionAsiaNortheast1 ScheduleRegion = "asia-northeast1"

const ScheduleRegionAsiaNortheast2 ScheduleRegion = "asia-northeast2"

const ScheduleRegionAsiaSouth1 ScheduleRegion = "asia-south1"

const ScheduleRegionAsiaSoutheast1 ScheduleRegion = "asia-southeast1"

const ScheduleRegionAustraliaSoutheast1 ScheduleRegion = "australia-southeast1"

const ScheduleRegionEuropeNorth1 ScheduleRegion = "europe-north1"

const ScheduleRegionEuropeSouthwest1 ScheduleRegion = "europe-southwest1"

const ScheduleRegionEuropeWest1 ScheduleRegion = "europe-west1"

const ScheduleRegionEuropeWest2 ScheduleRegion = "europe-west2"

const ScheduleRegionEuropeWest3 ScheduleRegion = "europe-west3"

const ScheduleRegionEuropeWest4 ScheduleRegion = "europe-west4"

const ScheduleRegionEuropeWest8 ScheduleRegion = "europe-west8"

const ScheduleRegionEuropeWest9 ScheduleRegion = "europe-west9"

const ScheduleRegionMeWest1 ScheduleRegion = "me-west1"

const ScheduleRegionSouthamericaEast1 ScheduleRegion = "southamerica-east1"

const ScheduleRegionUsCentral1 ScheduleRegion = "us-central1"

const ScheduleRegionUsEast1 ScheduleRegion = "us-east1"

const ScheduleRegionUsEast4 ScheduleRegion = "us-east4"

const ScheduleRegionUsSouth1 ScheduleRegion = "us-south1"

const ScheduleRegionUsWest1 ScheduleRegion = "us-west1"

URL stringoptional

A URL.

SpeedAvailabilities

Get quota and availability

client.Speed.Availabilities.List(ctx, query) (*Availability, error)

GET/zones/{zone_id}/speed_api/availabilities

ModelsExpand Collapse

type Availability struct{…}

Quota AvailabilityQuotaoptional

Plan stringoptional

Cloudflare plan.

QuotasPerPlan AvailabilityQuotaQuotasPerPlanoptional

The number of tests available per plan.

Value AvailabilityQuotaQuotasPerPlanValueoptional

Counts per account plan.

Business int64optional

Enterprise int64optional

Free int64optional

Pro int64optional

RemainingSchedules float64optional

The number of remaining schedules available.

RemainingTests float64optional

The number of remaining tests available.

ScheduleQuotasPerPlan AvailabilityQuotaScheduleQuotasPerPlanoptional

The number of schedules available per plan.

Value AvailabilityQuotaScheduleQuotasPerPlanValueoptional

Counts per account plan.

Business int64optional

Enterprise int64optional

Free int64optional

Pro int64optional

Regions []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

RegionsPerPlan AvailabilityRegionsPerPlanoptional

Available regions.

Business []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Enterprise []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Free []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

Pro []LabeledRegionoptional

Label stringoptional

Value LabeledRegionValueoptional

A test region.

One of the following:

const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1"

const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1"

const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2"

const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1"

const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1"

const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1"

const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1"

const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1"

const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1"

const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2"

const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3"

const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4"

const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8"

const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9"

const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1"

const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1"

const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1"

const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1"

const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4"

const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1"

const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1"

SpeedPages

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

SpeedPagesTests

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.