--- title: Speed --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Speed ##### ModelsExpand Collapse

LabeledRegion object {label, value } A test region with a label.

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property

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

LighthouseReport object {cls, deviceType, error, 9 more } The Lighthouse report.

cls: optional number Cumulative Layout Shift. Link to this property

deviceType: optional "DESKTOP"or "MOBILE" The type of device.

One of the following: "DESKTOP" Link to this property "MOBILE" Link to this property

Link to this property

error: optional object {code, detail, finalDisplayedUrl }

code: optional "NOT\_REACHABLE"or "DNS\_FAILURE"or "NOT\_HTML"or 2 more The error code of the Lighthouse result.

One of the following: "NOT\_REACHABLE" Link to this property "DNS\_FAILURE" Link to this property "NOT\_HTML" Link to this property "LIGHTHOUSE\_TIMEOUT" Link to this property "UNKNOWN" Link to this property

Link to this property detail: optional string Detailed error message. Link to this property finalDisplayedUrl: optional string The final URL displayed to the user. Link to this property

Link to this property fcp: optional number First Contentful Paint. Link to this property jsonReportUrl: optional string The URL to the full Lighthouse JSON report. Link to this property lcp: optional number Largest Contentful Paint. Link to this property performanceScore: optional number The Lighthouse performance score. Link to this property si: optional number Speed Index. Link to this property

state: optional "RUNNING"or "COMPLETE"or "FAILED" The state of the Lighthouse report.

One of the following: "RUNNING" Link to this property "COMPLETE" Link to this property "FAILED" Link to this property

Link to this property tbt: optional number Total Blocking Time. Link to this property ttfb: optional number Time To First Byte. Link to this property tti: optional number Time To Interactive. Link to this property

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

Trend object {cls, fcp, lcp, 5 more }

cls: optional array of number Cumulative Layout Shift trend. Link to this property fcp: optional array of number First Contentful Paint trend. Link to this property lcp: optional array of number Largest Contentful Paint trend. Link to this property performanceScore: optional array of number The Lighthouse score trend. Link to this property si: optional array of number Speed Index trend. Link to this property tbt: optional array of number Total Blocking Time trend. Link to this property ttfb: optional array of number Time To First Byte trend. Link to this property tti: optional array of number 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/resources/speed/subresources/schedule/methods/get) GET/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Create scheduled page test](https://developers.cloudflare.com/api/resources/speed/subresources/schedule/methods/create) POST/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Delete scheduled page test](https://developers.cloudflare.com/api/resources/speed/subresources/schedule/methods/delete) DELETE/zones/{zone\_id}/speed\_api/schedule/{url} ##### ModelsExpand Collapse

Schedule object {frequency, region, url } The test schedule.

frequency: optional "DAILY"or "WEEKLY" The frequency of the test.

One of the following: "DAILY" Link to this property "WEEKLY" Link to this property

Link to this property

region: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property url: optional string A URL. Link to this property

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

ScheduleCreateResponse object {schedule, test }

schedule: optional Schedule { frequency, region, url } The test schedule. Link to this property test: optional Test { id, date, desktopReport, 4 more } Link to this property

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

ScheduleDeleteResponse object {count }

count: optional number Number of items affected. Link to this property

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(model)%20schedule_delete_response%20%3E%20(schema)>) #### SpeedAvailabilities ##### [Get quota and availability](https://developers.cloudflare.com/api/resources/speed/subresources/availabilities/methods/list) GET/zones/{zone\_id}/speed\_api/availabilities ##### ModelsExpand Collapse

Availability object {quota, regions, regionsPerPlan }

quota: optional object {plan, quotasPerPlan, remainingSchedules, 2 more }

plan: optional string Cloudflare plan. Link to this property

quotasPerPlan: optional object {value } The number of tests available per plan.

value: optional object {business, enterprise, free, pro } Counts per account plan.

business: optional number Link to this property enterprise: optional number Link to this property free: optional number Link to this property pro: optional number Link to this property

Link to this property

Link to this property remainingSchedules: optional number The number of remaining schedules available. Link to this property remainingTests: optional number The number of remaining tests available. Link to this property

scheduleQuotasPerPlan: optional object {value } The number of schedules available per plan.

value: optional object {business, enterprise, free, pro } Counts per account plan.

business: optional number Link to this property enterprise: optional number Link to this property free: optional number Link to this property pro: optional number Link to this property

Link to this property

regions: optional array of LabeledRegion { label, value }

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property

regionsPerPlan: optional object {business, enterprise, free, pro } Available regions.

business: optional array of LabeledRegion { label, value }

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property

enterprise: optional array of LabeledRegion { label, value }

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property

free: optional array of LabeledRegion { label, value }

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more A test region.

Link to this property

pro: optional array of LabeledRegion { label, value }

label: optional string Link to this property

value: optional "asia-east1"or "asia-northeast1"or "asia-northeast2"or 18 more 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/resources/speed/subresources/pages/methods/list) GET/zones/{zone\_id}/speed\_api/pages ##### [List core web vital metrics trend](https://developers.cloudflare.com/api/resources/speed/subresources/pages/methods/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. Link to this property

scheduleFrequency: optional "DAILY"or "WEEKLY" The frequency of the test.

One of the following: "DAILY" Link to this property "WEEKLY" Link to this property

Link to this property

tests: optional array of Test { id, date, desktopReport, 4 more }

id: optional string UUID. maxLength36 Link to this property date: optional string formatdate-time Link to this property desktopReport: optional LighthouseReport { cls, deviceType, error, 9 more } The Lighthouse report. Link to this property mobileReport: optional LighthouseReport { cls, deviceType, error, 9 more } The Lighthouse report. Link to this property region: optional LabeledRegion { label, value } A test region with a label. Link to this property

scheduleFrequency: optional "DAILY"or "WEEKLY" The frequency of the test.

One of the following: "DAILY" Link to this property "WEEKLY" Link to this property

Link to this property url: optional string A URL. Link to this property

[Link to this property](<#(resource)%20speed.pages%20%3E%20(model)%20page_list_response%20%3E%20(schema)>) #### SpeedPagesTests ##### [List page test history](https://developers.cloudflare.com/api/resources/speed/subresources/pages/subresources/tests/methods/list) GET/zones/{zone\_id}/speed\_api/pages/{url}/tests ##### [Get a page test result](https://developers.cloudflare.com/api/resources/speed/subresources/pages/subresources/tests/methods/get) GET/zones/{zone\_id}/speed\_api/pages/{url}/tests/{test\_id} ##### [Start page test](https://developers.cloudflare.com/api/resources/speed/subresources/pages/subresources/tests/methods/create) POST/zones/{zone\_id}/speed\_api/pages/{url}/tests ##### [Delete all page tests](https://developers.cloudflare.com/api/resources/speed/subresources/pages/subresources/tests/methods/delete) DELETE/zones/{zone\_id}/speed\_api/pages/{url}/tests ##### ModelsExpand Collapse

Test object {id, date, desktopReport, 4 more }

scheduleFrequency: optional "DAILY"or "WEEKLY" The frequency of the test.

One of the following: "DAILY" Link to this property "WEEKLY" Link to this property

Link to this property url: optional string A URL. Link to this property

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

TestDeleteResponse object {count }

count: optional number Number of items affected. Link to this property

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