Creates a scheduled test for a page.
/zones/{zone_identifier}/speed_api/schedule/{url}
post
Observatory
speed-create-scheduled-test
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "path",
"name": "url",
"required": true,
"schema": {
"description": "A URL.",
"example": "example.com",
"type": "string"
}
},
{
"in": "query",
"name": "region",
"schema": {
"description": "A test region.",
"enum": [
"asia-east1",
"asia-northeast1",
"asia-northeast2",
"asia-south1",
"asia-southeast1",
"australia-southeast1",
"europe-north1",
"europe-southwest1",
"europe-west1",
"europe-west2",
"europe-west3",
"europe-west4",
"europe-west8",
"europe-west9",
"me-west1",
"southamerica-east1",
"us-central1",
"us-east1",
"us-east4",
"us-south1",
"us-west1"
],
"example": "us-central1",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"success": {
"description": "Whether the API call was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
}
],
"type": "object"
},
{
"properties": {
"result": {
"properties": {
"schedule": {
"description": "The test schedule.",
"properties": {
"frequency": {
"description": "The frequency of the test.",
"enum": [
"DAILY",
"WEEKLY"
],
"example": "DAILY",
"type": "string"
},
"region": {
"description": "A test region.",
"enum": [
"asia-east1",
"asia-northeast1",
"asia-northeast2",
"asia-south1",
"asia-southeast1",
"australia-southeast1",
"europe-north1",
"europe-southwest1",
"europe-west1",
"europe-west2",
"europe-west3",
"europe-west4",
"europe-west8",
"europe-west9",
"me-west1",
"southamerica-east1",
"us-central1",
"us-east1",
"us-east4",
"us-south1",
"us-west1"
],
"example": "us-central1",
"type": "string"
},
"url": {
"description": "A URL.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
},
"test": {
"properties": {
"date": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"desktopReport": {
"description": "The Lighthouse report.",
"properties": {
"cls": {
"description": "Cumulative Layout Shift.",
"example": 100,
"type": "number"
},
"deviceType": {
"description": "The type of device.",
"enum": [
"DESKTOP",
"MOBILE"
],
"example": "DESKTOP",
"type": "string"
},
"error": {
"properties": {
"code": {
"description": "The error code of the Lighthouse result.",
"enum": [
"NOT_REACHABLE",
"DNS_FAILURE",
"NOT_HTML",
"LIGHTHOUSE_TIMEOUT",
"UNKNOWN"
],
"example": "NOT_REACHABLE",
"type": "string"
},
"detail": {
"description": "Detailed error message.",
"example": "Details: net::ERR_CONNECTION_CLOSED",
"type": "string"
},
"finalDisplayedUrl": {
"description": "The final URL displayed to the user.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
},
"fcp": {
"description": "First Contentful Paint.",
"example": 100,
"type": "number"
},
"jsonReportUrl": {
"description": "The URL to the full Lighthouse JSON report.",
"type": "string"
},
"lcp": {
"description": "Largest Contentful Paint.",
"example": 100,
"type": "number"
},
"performanceScore": {
"description": "The Lighthouse performance score.",
"example": 90,
"type": "number"
},
"si": {
"description": "Speed Index.",
"example": 100,
"type": "number"
},
"state": {
"description": "The state of the Lighthouse report.",
"enum": [
"RUNNING",
"COMPLETE",
"FAILED"
],
"example": "COMPLETE",
"type": "string"
},
"tbt": {
"description": "Total Blocking Time.",
"example": 100,
"type": "number"
},
"ttfb": {
"description": "Time To First Byte.",
"example": 100,
"type": "number"
},
"tti": {
"description": "Time To Interactive.",
"example": 100,
"type": "number"
}
},
"type": "object"
},
"id": {
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
},
"mobileReport": {
"description": "The Lighthouse report.",
"properties": {
"cls": {
"description": "Cumulative Layout Shift.",
"example": 100,
"type": "number"
},
"deviceType": {
"description": "The type of device.",
"enum": [
"DESKTOP",
"MOBILE"
],
"example": "DESKTOP",
"type": "string"
},
"error": {
"properties": {
"code": {
"description": "The error code of the Lighthouse result.",
"enum": [
"NOT_REACHABLE",
"DNS_FAILURE",
"NOT_HTML",
"LIGHTHOUSE_TIMEOUT",
"UNKNOWN"
],
"example": "NOT_REACHABLE",
"type": "string"
},
"detail": {
"description": "Detailed error message.",
"example": "Details: net::ERR_CONNECTION_CLOSED",
"type": "string"
},
"finalDisplayedUrl": {
"description": "The final URL displayed to the user.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
},
"fcp": {
"description": "First Contentful Paint.",
"example": 100,
"type": "number"
},
"jsonReportUrl": {
"description": "The URL to the full Lighthouse JSON report.",
"type": "string"
},
"lcp": {
"description": "Largest Contentful Paint.",
"example": 100,
"type": "number"
},
"performanceScore": {
"description": "The Lighthouse performance score.",
"example": 90,
"type": "number"
},
"si": {
"description": "Speed Index.",
"example": 100,
"type": "number"
},
"state": {
"description": "The state of the Lighthouse report.",
"enum": [
"RUNNING",
"COMPLETE",
"FAILED"
],
"example": "COMPLETE",
"type": "string"
},
"tbt": {
"description": "Total Blocking Time.",
"example": 100,
"type": "number"
},
"ttfb": {
"description": "Time To First Byte.",
"example": 100,
"type": "number"
},
"tti": {
"description": "Time To Interactive.",
"example": 100,
"type": "number"
}
},
"type": "object"
},
"region": {
"description": "A test region with a label.",
"properties": {
"label": {
"example": "Iowa, USA",
"type": "string"
},
"value": {
"description": "A test region.",
"enum": [
"asia-east1",
"asia-northeast1",
"asia-northeast2",
"asia-south1",
"asia-southeast1",
"australia-southeast1",
"europe-north1",
"europe-southwest1",
"europe-west1",
"europe-west2",
"europe-west3",
"europe-west4",
"europe-west8",
"europe-west9",
"me-west1",
"southamerica-east1",
"us-central1",
"us-east1",
"us-east4",
"us-south1",
"us-west1"
],
"example": "us-central1",
"type": "string"
}
},
"type": "object"
},
"scheduleFrequency": {
"description": "The frequency of the test.",
"enum": [
"DAILY",
"WEEKLY"
],
"example": "DAILY",
"type": "string"
},
"url": {
"description": "A URL.",
"example": "example.com",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
}
}
]
}
}
},
"description": "Page test schedule"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Failure response"
}
}[
{
"api_email": [],
"api_key": []
}
]