List core web vital metrics trend

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

/zones/{zone_identifier}/speed_api/pages/{url}/trend

get

Observatory

speed-list-page-trend

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",
    "required": true,
    "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"
    }
  },
  {
    "in": "query",
    "name": "deviceType",
    "required": true,
    "schema": {
      "description": "The type of device.",
      "enum": [
        "DESKTOP",
        "MOBILE"
      ],
      "example": "DESKTOP",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "start",
    "required": true,
    "schema": {
      "example": "2014-01-01T05:20:00.12345Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "end",
    "schema": {
      "example": "2014-01-01T05:20:00.12345Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    }
  },
  {
    "description": "The timezone of the start and end timestamps.",
    "example": "America/Chicago",
    "in": "query",
    "name": "tz",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "description": "A comma-separated list of metrics to include in the results.",
    "in": "query",
    "name": "metrics",
    "required": true,
    "schema": {
      "example": "performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls",
      "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": {
                  "properties": {
                    "cls": {
                      "description": "Cumulative Layout Shift trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "fcp": {
                      "description": "First Contentful Paint trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "lcp": {
                      "description": "Largest Contentful Paint trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "performanceScore": {
                      "description": "The Lighthouse score trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "si": {
                      "description": "Speed Index trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "tbt": {
                      "description": "Total Blocking Time trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "ttfb": {
                      "description": "Time To First Byte trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    },
                    "tti": {
                      "description": "Time To Interactive trend.",
                      "items": {
                        "nullable": true,
                        "type": "number"
                      },
                      "type": "array"
                    }
                  },
                  "type": "object"
                }
              }
            }
          ]
        }
      }
    },
    "description": "Page trend"
  },
  "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": []
  }
]