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

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

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 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 {cls, deviceType, error, 9 more } The Lighthouse report.

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

deviceType?: "DESKTOP"| "MOBILE" The type of device.

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

Link to this property

error?: Error {code, detail, finalDisplayedUrl }

code?: "NOT\_REACHABLE"| "DNS\_FAILURE"| "NOT\_HTML"| 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?: string Detailed error message. Link to this property finalDisplayedUrl?: string The final URL displayed to the user. Link to this property

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

state?: "RUNNING"| "COMPLETE"| "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?: number Total Blocking Time. Link to this property ttfb?: number Time To First Byte. Link to this property tti?: 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 {cls, fcp, lcp, 5 more }

cls?: Array<number| null> Cumulative Layout Shift trend. Link to this property fcp?: Array<number| null> First Contentful Paint trend. Link to this property lcp?: Array<number| null> Largest Contentful Paint trend. Link to this property performanceScore?: Array<number| null> The Lighthouse score trend. Link to this property si?: Array<number| null> Speed Index trend. Link to this property tbt?: Array<number| null> Total Blocking Time trend. Link to this property ttfb?: Array<number| null> Time To First Byte trend. Link to this property tti?: Array<number| null> 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/typescript/resources/speed/subresources/schedule/methods/get) client.speed.schedule.get(stringurl, ScheduleGetParams {zone\_id, region } params, RequestOptionsoptions?): [Schedule]() {frequency, region, url } GET/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Create scheduled page test](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/schedule/methods/create) client.speed.schedule.create(stringurl, ScheduleCreateParams {zone\_id, frequency, region } params, RequestOptionsoptions?): [ScheduleCreateResponse]() {schedule, test } POST/zones/{zone\_id}/speed\_api/schedule/{url} ##### [Delete scheduled page test](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/schedule/methods/delete) client.speed.schedule.delete(stringurl, ScheduleDeleteParams {zone\_id, region } params, RequestOptionsoptions?): [ScheduleDeleteResponse]() {count } DELETE/zones/{zone\_id}/speed\_api/schedule/{url} ##### ModelsExpand Collapse

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

frequency?: "DAILY"| "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?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 18 more A test region.

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

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

ScheduleCreateResponse {schedule, test }

schedule?: Schedule {frequency, region, url } The test schedule. Link to this property test?: 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 {count }

count?: 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/typescript/resources/speed/subresources/availabilities/methods/list) client.speed.availabilities.list(AvailabilityListParams {zone\_id } params, RequestOptionsoptions?): [Availability]() {quota, regions, regionsPerPlan } GET/zones/{zone\_id}/speed\_api/availabilities ##### ModelsExpand Collapse

Availability {quota, regions, regionsPerPlan }

quota?: Quota {plan, quotasPerPlan, remainingSchedules, 2 more }

plan?: string Cloudflare plan. Link to this property

quotasPerPlan?: QuotasPerPlan {value } The number of tests available per plan.

value?: Value {business, enterprise, free, pro } Counts per account plan.

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

Link to this property

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

scheduleQuotasPerPlan?: ScheduleQuotasPerPlan {value } The number of schedules available per plan.

value?: Value {business, enterprise, free, pro } Counts per account plan.

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

Link to this property

regions?: Array<LabeledRegion {label, value } >

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 18 more A test region.

Link to this property

regionsPerPlan?: RegionsPerPlan {business, enterprise, free, pro } Available regions.

business?: Array<LabeledRegion {label, value } >

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 18 more A test region.

Link to this property

enterprise?: Array<LabeledRegion {label, value } >

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 18 more A test region.

Link to this property

free?: Array<LabeledRegion {label, value } >

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 18 more A test region.

Link to this property

pro?: Array<LabeledRegion {label, value } >

label?: string Link to this property

value?: "asia-east1"| "asia-northeast1"| "asia-northeast2"| 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/typescript/resources/speed/subresources/pages/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/pages/methods/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. Link to this property

scheduleFrequency?: "DAILY"| "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?: Array<Test {id, date, desktopReport, 4 more } >

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

scheduleFrequency?: "DAILY"| "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?: 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/typescript/resources/speed/subresources/pages/subresources/tests/methods/list) 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](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/pages/subresources/tests/methods/get) client.speed.pages.tests.get(stringtestID, TestGetParams {zone\_id, url } params, RequestOptionsoptions?): [Test]() {id, date, desktopReport, 4 more } GET/zones/{zone\_id}/speed\_api/pages/{url}/tests/{test\_id} ##### [Start page test](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/pages/subresources/tests/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/speed/subresources/pages/subresources/tests/methods/delete) 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 }

scheduleFrequency?: "DAILY"| "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?: 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 {count }

count?: 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)>)