openapi: 3.1.0
info:
  title: Interzoid Global Page Load Performance API
  description: >
    This API provides global page load (or API call) performance statistics by geographic region, allowing developers to understand and optimize the user experience based on results received from physical server locations globally.

    To use this API, you need an API key. Register for an API key at [Interzoid Registration](https://www.interzoid.com/register-api-account).

    For more information about this API, visit the [Interzoid Global Page Load Performance API Documentation](https://www.interzoid.com/apis/global-page-load-performance).
  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: Provides page load performance data by geographic region.
paths:
  /globalpageload:
    get:
      tags:
        - Global Page Load Performance
      summary: Retrieve Global Page Load Performance Statistics
      description: >
        This method retrieves page load performance metrics by geographic region, enabling optimization of website performance for users in different parts of the world.

        **Note**: You must include your API key as the `license` parameter in the request. If you do not have an API key, you can register for one at [Interzoid Registration](https://www.interzoid.com/register-api-account).
      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).
          schema:
            type: string
          examples:
            license:
                summary: API Key Example
                value: "6hd8s3bstd6e78ab9"
        - name: origin
          in: query
          required: true
          description: >
            The geographic origin of the request. Specify the region for which the page load performance data is requested (Tokyo, Sydney, California, London, Mumbai, Paris...).
          schema:
            type: string
          examples:
            origin:
                summary: Origin Example
                value: "Singapore"
        - name: url
          in: query
          required: true
          description: >
            The URL of the webpage for which the load performance data is requested.
          schema:
            type: string
          examples:
            url:
                summary: URL Example
                value: "https://www.ebay.com"
      responses:
        '200':
          description: Successful response containing page load performance data.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Origin:
                    type: string
                    description: The geographic origin of the request.
                  Seconds:
                    type: string
                    description: Page load time in seconds.
                  PageResponseStatus:
                    type: string
                    description: The status of the page response.
                  Contents:
                    type: string
                    description: Additional response details (if any).
                  Code:
                    type: string
                    description: Status code indicating success or failure.
                  Credits:
                    type: integer
                    description: Remaining credits for your API license.
                examples:
                  - summary: Successful response example
                    value:
                      Origin: "Singapore"
                      Seconds: "0.44"
                      PageResponseStatus: "200 OK"
                      Contents: ""
                      Code: "Success"
                      Credits: 1000008
        '400':
          description: Bad request (e.g., missing or invalid parameters).
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Missing or invalid parameters
                    value:
                      Code: "400"
                      Message: "Invalid license key or parameters missing."
        '402':
          description: API key not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: API key not found
                    value:
                      Code: "402"
                      Message: "API key not found."
        '403':
          description: Insufficient API credits remaining.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Insufficient credits
                    value:
                      Code: "403"
                      Message: "Insufficient API credits remaining."
        '405':
          description: Method not allowed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Wrong HTTP method
                    value:
                      Code: "405"
                      Message: "Method not allowed."
        '429':
          description: Rate limits reached.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Rate limit reached
                    value:
                      Code: "429"
                      Message: "Rate limits reached."
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Code:
                    type: string
                    description: Status code.
                  Message:
                    type: string
                    description: Error message.
                examples:
                  - summary: Server error
                    value:
                      Code: "500"
                      Message: "Internal server error."
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: license
      in: query
  schemas:
    ResponseError:
      type: object
      properties:
        Code:
          type: string
          description: Status code.
        Message:
          type: string
          description: Error message.
security:
  - apiKeyAuth: []