Cloudflare API | Speed › Pages › trend

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

List tested webpages

List core web vital metrics trend

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Leaked Credential Checks

Token Validation

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Speed

Speed

Domain types

LabeledRegion{…}

A test region with a label.

LighthouseReport{…}

The Lighthouse report.

Trend{…}

Availabilities

Speed.Availabilities

Methods

client.speed.availabilities.list(, ):

get/zones/{zone_id}/speed_api/availabilities

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

Domain types

Availability{…}

Pages

Speed.Pages

Methods

client.speed.pages.list(, ):

<

PageListResponse

>

get/zones/{zone_id}/speed_api/pages

Lists all webpages which have been tested.

client.speed.pages.trend(, , ):

get/zones/{zone_id}/speed_api/pages/{url}/trend

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

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Zone Settings Write Zone Settings Read

Parameters

url: string

A URL.

params:

PageTrendParams

zone_id: string

(maxLength: 32)

Path param: Identifier.

deviceType: "DESKTOP" | "MOBILE"

Query param: The type of device.

metrics: string

Query param: A comma-separated list of metrics to include in the results.

region: "asia-east1" | "asia-northeast1" | "asia-northeast2" | 18 more...

Query param: A test region.

start: string

(format: date-time)

Query param

tz: string

Query param: The timezone of the start and end timestamps.

end?: string

(format: date-time)

Query param

Returns

cls?: Array<number | null>

Cumulative Layout Shift trend.

fcp?: Array<number | null>

First Contentful Paint trend.

lcp?: Array<number | null>

Largest Contentful Paint trend.

performanceScore?: Array<number | null>

The Lighthouse score trend.

si?: Array<number | null>

Speed Index trend.

tbt?: Array<number | null>

Total Blocking Time trend.

ttfb?: Array<number | null>

Time To First Byte trend.

tti?: Array<number | null>

Time To Interactive trend.

Request example

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const trend = await client.speed.pages.trend('example.com', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  deviceType: 'DESKTOP',
  metrics: 'performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls',
  region: 'us-central1',
  start: '2014-01-01T05:20:00.12345Z',
  tz: 'tz',
});

console.log(trend.cls);

200Example

{
  "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": {
    "cls": [
      0
    ],
    "fcp": [
      0
    ],
    "lcp": [
      0
    ],
    "performanceScore": [
      0
    ],
    "si": [
      0
    ],
    "tbt": [
      0
    ],
    "ttfb": [
      0
    ],
    "tti": [
      0
    ]
  }
}

Tests

Speed.Pages.Tests

Methods

client.speed.pages.tests.list(, , ):

V4PagePaginationArray

<

>

get/zones/{zone_id}/speed_api/pages/{url}/tests

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

client.speed.pages.tests.get(, , , ):

get/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}

Retrieves the result of a specific test.

client.speed.pages.tests.create(, , ):

post/zones/{zone_id}/speed_api/pages/{url}/tests

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

client.speed.pages.tests.delete(, , ):

TestDeleteResponse

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.

Domain types

Test{…}

Schedule

Speed.ScheduleResource

Methods

client.speed.schedule.get(, , ):

get/zones/{zone_id}/speed_api/schedule/{url}

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

client.speed.schedule.create(, , ):

ScheduleCreateResponse

post/zones/{zone_id}/speed_api/schedule/{url}

Creates a scheduled test for a page.

client.speed.schedule.delete(, , ):

ScheduleDeleteResponse

delete/zones/{zone_id}/speed_api/schedule/{url}

Deletes a scheduled test for a page.

Domain types

Schedule{…}

The test schedule.