{ "openapi": "3.0.1", "info": { "title": "Bulk Lighthouse Audit – No API Key Needed", "description": "Run real Google Lighthouse on a list of URLs or a whole sitemap: Performance, Accessibility, Best Practices and SEO scores, LCP/CLS/TBT, top fixes with savings, failed audits and HTML reports. No PageSpeed API key or quota required. Export CSV or use in CI.", "version": "1.0", "x-build-id": "WjzaGyqynyjvYyqA9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/refillflows~bulk-lighthouse-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-refillflows-bulk-lighthouse-audit", "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/refillflows~bulk-lighthouse-audit/runs": { "post": { "operationId": "runs-sync-refillflows-bulk-lighthouse-audit", "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/refillflows~bulk-lighthouse-audit/run-sync": { "post": { "operationId": "run-sync-refillflows-bulk-lighthouse-audit", "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": "URLs", "type": "array", "description": "Pages to audit. Domains without https:// are fine.", "default": [], "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Audit pages from XML sitemaps (sitemap indexes and .gz supported), up to Max URLs.", "default": [], "items": { "type": "string" } }, "maxUrls": { "title": "Max URLs", "minimum": 1, "type": "integer", "description": "Cap on the number of pages audited (per strategy).", "default": 50 }, "strategies": { "title": "Devices", "type": "array", "description": "Mobile (Moto G Power, slow 4G throttling — Google's default) and/or desktop.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Which scores to compute. Fewer categories = faster.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "engine": { "title": "Engine", "enum": [ "auto", "local", "psi" ], "type": "string", "description": "auto = PageSpeed Insights API when a Google API key is provided, otherwise real Lighthouse runs inside the Actor (no key or quota needed).", "default": "auto" }, "googleApiKey": { "title": "Google API key (optional)", "type": "string", "description": "Free key from Google Cloud with PageSpeed Insights API and Chrome UX Report API enabled. Unlocks real-user Core Web Vitals (CrUX field data: LCP, INP, CLS p75) and the cheaper PSI engine." }, "includeFieldData": { "title": "Include real-user (CrUX) field data", "type": "boolean", "description": "Requires a Google API key. Falls back from URL-level to origin-level data.", "default": true }, "runsPerUrl": { "title": "Runs per URL", "minimum": 1, "maximum": 5, "type": "integer", "description": "Run Lighthouse several times and keep the median performance run (Google recommends 3-5 for stable numbers). Each run is billed.", "default": 1 }, "performanceThreshold": { "title": "Performance budget (0-100)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional. Adds passedThreshold = true/false per page; useful for CI/monitoring alerts." }, "maxOpportunities": { "title": "Top opportunities per page", "minimum": 0, "type": "integer", "description": "How many 'fix this first' recommendations (with estimated savings) to include.", "default": 5 }, "includeFailedAudits": { "title": "List failed accessibility / SEO / best-practice audits", "type": "boolean", "description": "Adds the titles of failing audits per category.", "default": true }, "saveHtmlReports": { "title": "Save full HTML Lighthouse reports", "type": "boolean", "description": "Stores the shareable Lighthouse HTML report for each page in the key-value store and adds reportUrl (local engine only).", "default": false }, "maxConcurrency": { "title": "Parallel audits", "minimum": 1, "maximum": 10, "type": "integer", "description": "Local engine: 1 gives the most stable scores (CPU contention skews metrics). Use 2-4 with 4+ GB memory for speed. PSI engine: up to 10.", "default": 1 }, "auditTimeoutSecs": { "title": "Timeout per audit (s)", "minimum": 30, "type": "integer", "description": "Abort a single page audit after this time.", "default": 120 } } }, "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 } } } } } } } } } }