{
  "openapi": "3.0.1",
  "info": {
    "title": "Bulk PageSpeed Insights & Core Web Vitals Checker",
    "description": "Bulk PageSpeed Insights and Lighthouse audits for whole websites. Get performance, SEO and accessibility scores, real-user Core Web Vitals (LCP, INP, CLS) with pass/fail, top fixes, and regression alerts.",
    "version": "1.0",
    "x-build-id": "DBQqCTWV6GaGcDw3o"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zrk1212~pagespeed-bulk-auditor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zrk1212-pagespeed-bulk-auditor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/zrk1212~pagespeed-bulk-auditor/runs": {
      "post": {
        "operationId": "runs-sync-zrk1212-pagespeed-bulk-auditor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/zrk1212~pagespeed-bulk-auditor/run-sync": {
      "post": {
        "operationId": "run-sync-zrk1212-pagespeed-bulk-auditor",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "urls": {
            "title": "Page URLs",
            "type": "array",
            "description": "Pages to audit. Full URLs including https://. Each URL is audited once per strategy.",
            "items": {
              "type": "string"
            }
          },
          "startDomains": {
            "title": "Whole websites (domains)",
            "type": "array",
            "description": "Domains to audit as a whole site, for example example.com. The actor finds the sitemap automatically (robots.txt, /sitemap.xml, /sitemap_index.xml) and audits up to \"Max pages per site\" pages. If no sitemap is found, only the homepage is audited.",
            "items": {
              "type": "string"
            }
          },
          "sitemapUrls": {
            "title": "Sitemap URLs",
            "type": "array",
            "description": "Direct sitemap URLs (XML, sitemap index, or .xml.gz). Pages are taken from the sitemap up to \"Max pages per site\" per sitemap.",
            "items": {
              "type": "string"
            }
          },
          "maxPagesPerSite": {
            "title": "Max pages per site",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Maximum pages taken from each domain or sitemap. For domains, the homepage is always included first.",
            "default": 25
          },
          "sitemapSampling": {
            "title": "Sitemap sampling",
            "enum": [
              "spread",
              "first"
            ],
            "type": "string",
            "description": "spread picks pages evenly across the sitemap so the audit covers different sections. first takes pages in sitemap order.",
            "default": "spread"
          },
          "strategy": {
            "title": "Device",
            "enum": [
              "mobile",
              "desktop",
              "both"
            ],
            "type": "string",
            "description": "Device to emulate. Both produces two rows per URL and costs two audits. Google ranks on mobile, so mobile is the default.",
            "default": "mobile"
          },
          "categories": {
            "title": "Lighthouse categories",
            "type": "array",
            "description": "Lighthouse categories to score. Performance is always included.",
            "items": {
              "type": "string",
              "enum": [
                "performance",
                "seo",
                "accessibility",
                "best-practices"
              ],
              "enumTitles": [
                "Performance",
                "SEO",
                "Accessibility",
                "Best practices"
              ]
            },
            "default": [
              "performance",
              "seo",
              "accessibility",
              "best-practices"
            ]
          },
          "includeFieldData": {
            "title": "Include real-user Core Web Vitals",
            "type": "boolean",
            "description": "Add real-user Core Web Vitals from the Chrome UX Report (URL level and origin level). Free of extra charge.",
            "default": true
          },
          "fieldDataOnly": {
            "title": "Field data only (fast, cheap)",
            "type": "boolean",
            "description": "Skip Lighthouse and only fetch real-user Chrome UX Report data. Much faster and cheaper (charged as a field check, not an audit). Pages without enough Chrome traffic return no-data.",
            "default": false
          },
          "maxOpportunities": {
            "title": "Top fixes per page",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "How many top Lighthouse fixes (opportunities) to include per page, sorted by estimated time savings.",
            "default": 5
          },
          "includeSiteSummary": {
            "title": "Site summary rows",
            "type": "boolean",
            "description": "Add one free summary row per site with averages, Core Web Vitals pass rate, worst pages and the most common fixes.",
            "default": true
          },
          "monitorMode": {
            "title": "Monitor mode (regression alerts)",
            "type": "boolean",
            "description": "Compare with the previous run that used the same monitor ID and flag regressions. Use with an Apify Schedule for daily or weekly monitoring.",
            "default": false
          },
          "monitorId": {
            "title": "Monitor ID",
            "type": "string",
            "description": "Name of this monitor (letters, numbers, dashes). If empty while monitor mode is on, an ID is derived from the input URLs."
          },
          "regressionThreshold": {
            "title": "Regression threshold (points)",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Performance score drop (in points) that counts as a regression in monitor mode. Lab scores naturally vary 5 to 10 points between runs.",
            "default": 10
          },
          "locale": {
            "title": "Language",
            "type": "string",
            "description": "Language for opportunity titles, for example en, de, fr.",
            "default": "en"
          },
          "googleApiKey": {
            "title": "Your Google API key (optional, cheaper)",
            "type": "string",
            "description": "Optional. Your own Google Cloud API key with the PageSpeed Insights API (and optionally the Chrome UX Report API) enabled. Gives you your own daily Google quota (typically 25,000 audits per day), larger runs, and a lower price per audit."
          },
          "maxConcurrency": {
            "title": "Parallel audits",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "Parallel audits. Without your own API key the actor uses at most 8. Values above 8 need your own key and 1024 MB memory.",
            "default": 6
          },
          "maxAudits": {
            "title": "Max audits per run",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Hard cap on audits in this run (each URL plus device counts as one). Protects your budget. Runs on the shared key are capped at 1,000.",
            "default": 500
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}