Get a page test schedule

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

/zones/{zone_identifier}/speed_api/schedule/{url}

get

Observatory

speed-get-scheduled-test

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

null

Debug "parameters"

[
  {
    "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"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "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": {
                  "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"
                }
              }
            }
          ]
        }
      }
    },
    "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"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]