LogoCloudflare API

Speed

speed

Domain types

LabeledRegion = { label, value }

A test region with a label.

LighthouseReport = { cls, deviceType, error, 9 more... }

The Lighthouse report.

Trend = { cls, fcp, lcp, 5 more... }
Speed

Availabilities

speed.availabilities

Methods

Get Quota And Availability -> Envelope<
Availability
>
get/zones/{zone_id}/speed_api/availabilities

Retrieves quota for all plans, as well as the current zone quota.

Domain types

Availability = { quota, regions, regionsPerPlan }
Speed

Pages

speed.pages

Methods

List Tested Webpages -> SinglePage<{ region, scheduleFrequency, tests, 1 more... }>
get/zones/{zone_id}/speed_api/pages

Lists all webpages which have been tested.

List Core Web Vital Metrics Trend -> Envelope<
Trend
>
get/zones/{zone_id}/speed_api/pages/{url}/trend

Lists the core web vital metrics trend over time for a specific page.

SpeedPages

Tests

speed.pages.tests

Methods

Start Page Test -> Envelope<
Test
>
post/zones/{zone_id}/speed_api/pages/{url}/tests

Starts a test for a specific webpage, in a specific region.

Delete All Page Tests -> Envelope<{ count }>
delete/zones/{zone_id}/speed_api/pages/{url}/tests

Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.

Get A Page Test Result -> Envelope<
Test
>
get/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}

Retrieves the result of a specific test.

List Page Test History -> V4PagePaginationArray<
Test
>
get/zones/{zone_id}/speed_api/pages/{url}/tests

Test history (list of tests) for a specific webpage.

Domain types

Test = { id, date, desktopReport, 4 more... }
Speed

Schedule

speed.schedule

Methods

Create Scheduled Page Test -> Envelope<{ schedule, test }>
post/zones/{zone_id}/speed_api/schedule/{url}

Creates a scheduled test for a page.

Delete Scheduled Page Test -> Envelope<{ count }>
delete/zones/{zone_id}/speed_api/schedule/{url}

Deletes a scheduled test for a page.

Get A Page Test Schedule -> Envelope<
Schedule
>
get/zones/{zone_id}/speed_api/schedule/{url}

Retrieves the test schedule for a page in a specific region.

Domain types

Schedule = { frequency, region, url }

The test schedule.