List tested webpages
client.speed.pages.list(PageListParams { zone_id } params, RequestOptionsoptions?): SinglePage<PageListResponse { region, scheduleFrequency, tests, url } >
GET/zones/{zone_id}/speed_api/pages
Lists all webpages which have been tested.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
List tested webpages
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const pageListResponse of client.speed.pages.list({
zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
console.log(pageListResponse.region);
}{
"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": [
{
"region": {
"label": "Iowa, USA",
"value": "us-central1"
},
"scheduleFrequency": "DAILY",
"tests": [
{
"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"
}
],
"url": "example.com"
}
]
}Returns Examples
{
"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": [
{
"region": {
"label": "Iowa, USA",
"value": "us-central1"
},
"scheduleFrequency": "DAILY",
"tests": [
{
"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"
}
],
"url": "example.com"
}
]
}