--- title: Speed --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) 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 Link to this property

Value LabeledRegionValueOptional A test region.

One of the following: const LabeledRegionValueAsiaEast1 LabeledRegionValue = "asia-east1" Link to this property const LabeledRegionValueAsiaNortheast1 LabeledRegionValue = "asia-northeast1" Link to this property const LabeledRegionValueAsiaNortheast2 LabeledRegionValue = "asia-northeast2" Link to this property const LabeledRegionValueAsiaSouth1 LabeledRegionValue = "asia-south1" Link to this property const LabeledRegionValueAsiaSoutheast1 LabeledRegionValue = "asia-southeast1" Link to this property const LabeledRegionValueAustraliaSoutheast1 LabeledRegionValue = "australia-southeast1" Link to this property const LabeledRegionValueEuropeNorth1 LabeledRegionValue = "europe-north1" Link to this property const LabeledRegionValueEuropeSouthwest1 LabeledRegionValue = "europe-southwest1" Link to this property const LabeledRegionValueEuropeWest1 LabeledRegionValue = "europe-west1" Link to this property const LabeledRegionValueEuropeWest2 LabeledRegionValue = "europe-west2" Link to this property const LabeledRegionValueEuropeWest3 LabeledRegionValue = "europe-west3" Link to this property const LabeledRegionValueEuropeWest4 LabeledRegionValue = "europe-west4" Link to this property const LabeledRegionValueEuropeWest8 LabeledRegionValue = "europe-west8" Link to this property const LabeledRegionValueEuropeWest9 LabeledRegionValue = "europe-west9" Link to this property const LabeledRegionValueMeWest1 LabeledRegionValue = "me-west1" Link to this property const LabeledRegionValueSouthamericaEast1 LabeledRegionValue = "southamerica-east1" Link to this property const LabeledRegionValueUsCentral1 LabeledRegionValue = "us-central1" Link to this property const LabeledRegionValueUsEast1 LabeledRegionValue = "us-east1" Link to this property const LabeledRegionValueUsEast4 LabeledRegionValue = "us-east4" Link to this property const LabeledRegionValueUsSouth1 LabeledRegionValue = "us-south1" Link to this property const LabeledRegionValueUsWest1 LabeledRegionValue = "us-west1" Link to this property

Link to this property

[Link to this property](<#(resource)%20speed%20%3E%20(model)%20labeled_region%20%3E%20(schema)>)

type LighthouseReport struct{…} The Lighthouse report.

CLS float64Optional Cumulative Layout Shift. Link to this property

DeviceType LighthouseReportDeviceTypeOptional The type of device.

One of the following: const LighthouseReportDeviceTypeDesktop LighthouseReportDeviceType = "DESKTOP" Link to this property const LighthouseReportDeviceTypeMobile LighthouseReportDeviceType = "MOBILE" Link to this property

Link to this property

Error LighthouseReportErrorOptional

Code LighthouseReportErrorCodeOptional The error code of the Lighthouse result.

One of the following: const LighthouseReportErrorCodeNotReachable LighthouseReportErrorCode = "NOT\_REACHABLE" Link to this property const LighthouseReportErrorCodeDNSFailure LighthouseReportErrorCode = "DNS\_FAILURE" Link to this property const LighthouseReportErrorCodeNotHTML LighthouseReportErrorCode = "NOT\_HTML" Link to this property const LighthouseReportErrorCodeLighthouseTimeout LighthouseReportErrorCode = "LIGHTHOUSE\_TIMEOUT" Link to this property const LighthouseReportErrorCodeUnknown LighthouseReportErrorCode = "UNKNOWN" Link to this property

Link to this property Detail stringOptional Detailed error message. Link to this property FinalDisplayedURL stringOptional The final URL displayed to the user. Link to this property

Link to this property FCP float64Optional First Contentful Paint. Link to this property JsonReportURL stringOptional The URL to the full Lighthouse JSON report. Link to this property LCP float64Optional Largest Contentful Paint. Link to this property PerformanceScore float64Optional The Lighthouse performance score. Link to this property Si float64Optional Speed Index. Link to this property

State LighthouseReportStateOptional The state of the Lighthouse report.

One of the following: const LighthouseReportStateRunning LighthouseReportState = "RUNNING" Link to this property const LighthouseReportStateComplete LighthouseReportState = "COMPLETE" Link to this property const LighthouseReportStateFailed LighthouseReportState = "FAILED" Link to this property

Link to this property TBT float64Optional Total Blocking Time. Link to this property TTFB float64Optional Time To First Byte. Link to this property TTI float64Optional Time To Interactive. Link to this property

[Link to this property](<#(resource)%20speed%20%3E%20(model)%20lighthouse_report%20%3E%20(schema)>)

type Trend struct{…}

CLS \[]float64Optional Cumulative Layout Shift trend. Link to this property FCP \[]float64Optional First Contentful Paint trend. Link to this property LCP \[]float64Optional Largest Contentful Paint trend. Link to this property PerformanceScore \[]float64Optional The Lighthouse score trend. Link to this property Si \[]float64Optional Speed Index trend. Link to this property TBT \[]float64Optional Total Blocking Time trend. Link to this property TTFB \[]float64Optional Time To First Byte trend. Link to this property TTI \[]float64Optional Time To Interactive trend. Link to this property

[Link to this property](<#(resource)%20speed%20%3E%20(model)%20trend%20%3E%20(schema)>) #### SpeedSchedule ##### [Get a page test schedule](https://developers.cloudflare.com/api/go/resources/speed/subresources/schedule/methods/get) client.Speed.Schedule.Get(ctx, url, params) (\*[Schedule](), error) GET/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Create scheduled page test](https://developers.cloudflare.com/api/go/resources/speed/subresources/schedule/methods/create) client.Speed.Schedule.New(ctx, url, params) (\*[ScheduleNewResponse](), error) POST/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Delete scheduled page test](https://developers.cloudflare.com/api/go/resources/speed/subresources/schedule/methods/delete) 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" Link to this property const ScheduleFrequencyWeekly ScheduleFrequency = "WEEKLY" Link to this property

Link to this property

Region ScheduleRegionOptional A test region.

One of the following: const ScheduleRegionAsiaEast1 ScheduleRegion = "asia-east1" Link to this property const ScheduleRegionAsiaNortheast1 ScheduleRegion = "asia-northeast1" Link to this property const ScheduleRegionAsiaNortheast2 ScheduleRegion = "asia-northeast2" Link to this property const ScheduleRegionAsiaSouth1 ScheduleRegion = "asia-south1" Link to this property const ScheduleRegionAsiaSoutheast1 ScheduleRegion = "asia-southeast1" Link to this property const ScheduleRegionAustraliaSoutheast1 ScheduleRegion = "australia-southeast1" Link to this property const ScheduleRegionEuropeNorth1 ScheduleRegion = "europe-north1" Link to this property const ScheduleRegionEuropeSouthwest1 ScheduleRegion = "europe-southwest1" Link to this property const ScheduleRegionEuropeWest1 ScheduleRegion = "europe-west1" Link to this property const ScheduleRegionEuropeWest2 ScheduleRegion = "europe-west2" Link to this property const ScheduleRegionEuropeWest3 ScheduleRegion = "europe-west3" Link to this property const ScheduleRegionEuropeWest4 ScheduleRegion = "europe-west4" Link to this property const ScheduleRegionEuropeWest8 ScheduleRegion = "europe-west8" Link to this property const ScheduleRegionEuropeWest9 ScheduleRegion = "europe-west9" Link to this property const ScheduleRegionMeWest1 ScheduleRegion = "me-west1" Link to this property const ScheduleRegionSouthamericaEast1 ScheduleRegion = "southamerica-east1" Link to this property const ScheduleRegionUsCentral1 ScheduleRegion = "us-central1" Link to this property const ScheduleRegionUsEast1 ScheduleRegion = "us-east1" Link to this property const ScheduleRegionUsEast4 ScheduleRegion = "us-east4" Link to this property const ScheduleRegionUsSouth1 ScheduleRegion = "us-south1" Link to this property const ScheduleRegionUsWest1 ScheduleRegion = "us-west1" Link to this property

Link to this property URL stringOptional A URL. Link to this property

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(model)%20schedule%20%3E%20(schema)>) #### SpeedAvailabilities ##### [Get quota and availability](https://developers.cloudflare.com/api/go/resources/speed/subresources/availabilities/methods/list) 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. Link to this property

QuotasPerPlan AvailabilityQuotaQuotasPerPlanOptional The number of tests available per plan.

Value AvailabilityQuotaQuotasPerPlanValueOptional Counts per account plan.

Business int64Optional Link to this property Enterprise int64Optional Link to this property Free int64Optional Link to this property Pro int64Optional Link to this property

Link to this property

Link to this property RemainingSchedules float64Optional The number of remaining schedules available. Link to this property RemainingTests float64Optional The number of remaining tests available. Link to this property

ScheduleQuotasPerPlan AvailabilityQuotaScheduleQuotasPerPlanOptional The number of schedules available per plan.

Value AvailabilityQuotaScheduleQuotasPerPlanValueOptional Counts per account plan.

Business int64Optional Link to this property Enterprise int64Optional Link to this property Free int64Optional Link to this property Pro int64Optional Link to this property

Link to this property

Regions \[]LabeledRegionOptional

Label stringOptional Link to this property

Value LabeledRegionValueOptional A test region.

Link to this property

RegionsPerPlan AvailabilityRegionsPerPlanOptional Available regions.

Business \[]LabeledRegionOptional

Label stringOptional Link to this property

Value LabeledRegionValueOptional A test region.

Link to this property

Enterprise \[]LabeledRegionOptional

Label stringOptional Link to this property

Value LabeledRegionValueOptional A test region.

Link to this property

Free \[]LabeledRegionOptional

Label stringOptional Link to this property

Value LabeledRegionValueOptional A test region.

Link to this property

Pro \[]LabeledRegionOptional

Label stringOptional Link to this property

Value LabeledRegionValueOptional A test region.

Link to this property

[Link to this property](<#(resource)%20speed.availabilities%20%3E%20(model)%20availability%20%3E%20(schema)>) #### SpeedPages ##### [List tested webpages](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/methods/list) client.Speed.Pages.List(ctx, query) (\*SinglePage\[[PageListResponse]()], error) GET/zones/{zone\_id}/speed\_api/pages ##### [List core web vital metrics trend](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/methods/trend) client.Speed.Pages.Trend(ctx, url, params) (\*[Trend](), error) GET/zones/{zone\_id}/speed\_api/pages/{url}/trend #### SpeedPagesTests ##### [List page test history](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/subresources/tests/methods/list) 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](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/subresources/tests/methods/get) 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](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/subresources/tests/methods/create) client.Speed.Pages.Tests.New(ctx, url, params) (\*[Test](), error) POST/zones/{zone\_id}/speed\_api/pages/{url}/tests ##### [Delete all page tests](https://developers.cloudflare.com/api/go/resources/speed/subresources/pages/subresources/tests/methods/delete) 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 Link to this property Date TimeOptional formatdate-time Link to this property DesktopReport LighthouseReportOptional The Lighthouse report. Link to this property MobileReport LighthouseReportOptional The Lighthouse report. Link to this property Region LabeledRegionOptional A test region with a label. Link to this property

ScheduleFrequency TestScheduleFrequencyOptional The frequency of the test.

One of the following: const TestScheduleFrequencyDaily TestScheduleFrequency = "DAILY" Link to this property const TestScheduleFrequencyWeekly TestScheduleFrequency = "WEEKLY" Link to this property

Link to this property URL stringOptional A URL. Link to this property

[Link to this property](<#(resource)%20speed.pages.tests%20%3E%20(model)%20test%20%3E%20(schema)>)