--- title: Create scheduled page test --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Speed](https://developers.cloudflare.com/api/resources/speed) [Schedule](https://developers.cloudflare.com/api/resources/speed/subresources/schedule) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create scheduled page test POST/zones/{zone\_id}/speed\_api/schedule/{url} Creates a scheduled test for a page. ##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

##### Accepted Permissions (at least one required) `Zone Settings Write` ##### P ath ParametersExpand Collapse zone\_id: string Identifier. maxLength32 [Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) url: string A URL. [Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20url%20%3E%20(schema)>) ##### Q uery ParametersExpand Collapse

frequency: optional "DAILY"or "WEEKLY" The frequency of the scheduled test. Defaults to WEEKLY for free plans, DAILY for paid plans.

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

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20frequency%20%3E%20(schema)>)

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

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20region%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

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

messages: array of ResponseInfo { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: boolean Whether the API call was successful. [Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional object {schedule, test }

schedule: optional Schedule { 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

test: optional 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.

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

mobileReport: optional LighthouseReport { 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.

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

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

region: optional LabeledRegion { 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

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

[Link to this property](<#(resource)%20speed.schedule%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Create scheduled page test HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/speed_api/schedule/$URL \ -X POST \ -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "schedule": { "frequency": "DAILY", "region": "us-central1", "url": "example.com" }, "test": { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "date": "2014-01-01T05:20:00.12345Z", "desktopReport": { "cls": 100, "deviceType": "DESKTOP", "error": { "code": "NOT_REACHABLE", "detail": "Details: net::ERR_CONNECTION_CLOSED", "finalDisplayedUrl": "example.com" }, "fcp": 100, "jsonReportUrl": "jsonReportUrl", "lcp": 100, "performanceScore": 90, "si": 100, "state": "COMPLETE", "tbt": 100, "ttfb": 100, "tti": 100 }, "mobileReport": { "cls": 100, "deviceType": "DESKTOP", "error": { "code": "NOT_REACHABLE", "detail": "Details: net::ERR_CONNECTION_CLOSED", "finalDisplayedUrl": "example.com" }, "fcp": 100, "jsonReportUrl": "jsonReportUrl", "lcp": 100, "performanceScore": 90, "si": 100, "state": "COMPLETE", "tbt": 100, "ttfb": 100, "tti": 100 }, "region": { "label": "Iowa, USA", "value": "us-central1" }, "scheduleFrequency": "DAILY", "url": "example.com" } } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "schedule": { "frequency": "DAILY", "region": "us-central1", "url": "example.com" }, "test": { "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", "date": "2014-01-01T05:20:00.12345Z", "desktopReport": { "cls": 100, "deviceType": "DESKTOP", "error": { "code": "NOT_REACHABLE", "detail": "Details: net::ERR_CONNECTION_CLOSED", "finalDisplayedUrl": "example.com" }, "fcp": 100, "jsonReportUrl": "jsonReportUrl", "lcp": 100, "performanceScore": 90, "si": 100, "state": "COMPLETE", "tbt": 100, "ttfb": 100, "tti": 100 }, "mobileReport": { "cls": 100, "deviceType": "DESKTOP", "error": { "code": "NOT_REACHABLE", "detail": "Details: net::ERR_CONNECTION_CLOSED", "finalDisplayedUrl": "example.com" }, "fcp": 100, "jsonReportUrl": "jsonReportUrl", "lcp": 100, "performanceScore": 90, "si": 100, "state": "COMPLETE", "tbt": 100, "ttfb": 100, "tti": 100 }, "region": { "label": "Iowa, USA", "value": "us-central1" }, "scheduleFrequency": "DAILY", "url": "example.com" } } } ```