{
  "openapi": "3.1.0",
  "info": {
    "title": "Get Global Page Load Performance API",
    "description": "This API measures and returns page load performance data from various global locations, providing insights into website responsiveness and latency.\nTo use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\nFor more information about this API, visit the [Get Global Page Load Performance API Documentation](https://www.interzoid.com/apis/global-page-load-performance).\nYou can also try this API [interactively](https://try.interzoid.com) or in high-speed [batch mode](https://batch.interzoid.com).\n",
    "version": "1.0.0",
    "contact": {
      "name": "Interzoid Support",
      "url": "https://www.interzoid.com",
      "email": "support@interzoid.com"
    }
  },
  "externalDocs": {
    "description": "API home page and documentation",
    "url": "https://www.interzoid.com/apis/global-page-load-performance"
  },
  "servers": [
    {
      "url": "https://api.interzoid.com",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "Global Page Load Performance",
      "description": "Measures website load times from different geographic origins."
    }
  ],
  "paths": {
    "/globalpageload": {
      "get": {
        "operationId": "getGlobalPageLoad",
        "tags": [
          "Global Page Load Performance"
        ],
        "summary": "Retrieve Page Load Performance Data",
        "description": "Retrieves page load performance metrics for a specified URL from a given geographic origin. Include your API key (license) in the request. Register for an API key at https://www.interzoid.com/register-api-account.\n",
        "parameters": [
          {
            "name": "license",
            "in": "query",
            "required": true,
            "description": "Your API license key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).\n",
            "schema": {
              "type": "string"
            },
            "examples": {
              "license": {
                "summary": "API Key Example",
                "value": "6hd8s3bs***"
              }
            }
          },
          {
            "name": "origin",
            "in": "query",
            "required": true,
            "description": "The geographic origin from which the page load is measured.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "origin": {
                "summary": "Origin Example",
                "value": "Singapore"
              }
            }
          },
          {
            "name": "url",
            "in": "query",
            "required": true,
            "description": "The URL of the webpage to measure load performance for.",
            "schema": {
              "type": "string"
            },
            "examples": {
              "url": {
                "summary": "URL Example",
                "value": "http://www.ebay.com"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response containing the page load performance data.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "Origin": {
                      "type": "string",
                      "description": "The geographic origin of the measurement."
                    },
                    "Seconds": {
                      "type": "string",
                      "description": "The time in seconds taken to load the page."
                    },
                    "PageResponseStatus": {
                      "type": "string",
                      "description": "The HTTP status of the page response."
                    },
                    "Code": {
                      "type": "string",
                      "description": "Response code, \"Success\" if the call is successful."
                    },
                    "Credits": {
                      "type": "integer",
                      "description": "Remaining credits for your API license."
                    },
                    "Contents": {
                      "type": "string",
                      "description": "Additional content (if any), typically empty."
                    }
                  }
                },
                "examples": {
                  "success": {
                    "value": {
                      "Origin": "Singapore",
                      "Seconds": "0.44",
                      "PageResponseStatus": "200 OK",
                      "Code": "Success",
                      "Credits": 1000008,
                      "Contents": ""
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request (e.g., missing or invalid parameters).",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Invalid license key or origin/URL missing."
                  }
                }
              }
            }
          },
          "402": {
            "description": "API key not found.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "API key not found."
                  }
                }
              }
            }
          },
          "403": {
            "description": "Insufficient API credits remaining.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Insufficient API credits remaining."
                  }
                }
              }
            }
          },
          "405": {
            "description": "Method not allowed.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Method not allowed."
                  }
                }
              }
            }
          },
          "429": {
            "description": "Rate limits reached.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Rate limits reached."
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal server error.",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "examples": {
                  "error": {
                    "value": "Internal server error."
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "name": "license",
        "in": "query"
      }
    },
    "schemas": {}
  },
  "security": [
    {
      "apiKeyAuth": []
    }
  ]
}