{ "openapi": "3.0.1", "info": { "title": "Bulk Lighthouse & PageSpeed Audit – Core Web Vitals", "description": "Run Google Lighthouse on many URLs or a whole sitemap, mobile and desktop. Get performance, SEO, accessibility and best-practice scores, Core Web Vitals, top fixes, budget pass/fail and HTML reports. No API key needed. Failed audits are free.", "version": "0.0", "x-build-id": "ZzapO3QCL3dfwPgcm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/chris_elder~lighthouse-batch-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-chris_elder-lighthouse-batch-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/chris_elder~lighthouse-batch-auditor/runs": { "post": { "operationId": "runs-sync-chris_elder-lighthouse-batch-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/chris_elder~lighthouse-batch-auditor/run-sync": { "post": { "operationId": "run-sync-chris_elder-lighthouse-batch-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.", "default": [ { "url": "https://www.gov.uk" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sitemapUrls": { "title": "Sitemap URLs (optional)", "type": "array", "description": "Audit the pages listed in these XML sitemaps (sitemap indexes are followed). Combined with Page URLs, up to 'Max URLs'.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxUrls": { "title": "Max URLs", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of unique pages to audit (each page is audited once per selected device).", "default": 50 }, "strategies": { "title": "Devices", "type": "array", "description": "Mobile (Moto G Power emulation, slow 4G throttling) and/or desktop. Each device is a separate audit.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Categories", "type": "array", "description": "Lighthouse categories to score.", "items": { "type": "string", "enum": [ "performance", "accessibility", "bestPractices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "bestPractices", "seo" ] }, "engine": { "title": "Engine", "enum": [ "auto", "lighthouse", "psi" ], "type": "string", "description": "lighthouse = run Lighthouse on Apify (no key needed). psi = Google PageSpeed Insights API with YOUR free API key (cheaper per audit, adds real-user CrUX field data). auto = psi if a key is given, else lighthouse.", "default": "auto" }, "psiApiKey": { "title": "PageSpeed Insights API key (optional)", "type": "string", "description": "Your own free Google API key with the PageSpeed Insights API enabled. Stored encrypted; never logged." }, "budget": { "title": "Pass/fail thresholds (budget)", "type": "object", "description": "Optional thresholds. Each audit gets budget.passed true/false with reasons. Keys: minPerformanceScore, minAccessibilityScore, minSeoScore, minBestPracticesScore (0-100), maxLcpMs, maxTbtMs, maxCls.", "default": {} }, "saveHtmlReports": { "title": "Save full HTML reports", "type": "boolean", "description": "Store the full interactive Lighthouse HTML report for every audit in the key-value store and link it from the results.", "default": false }, "sameHostDelayMs": { "title": "Delay between audits of the same site (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Politeness delay so the audited website isn't loaded heavily.", "default": 1000 }, "pageTimeoutSecs": { "title": "Page load timeout (seconds)", "minimum": 15, "maximum": 180, "type": "integer", "description": "How long to wait for a page to load before the audit is marked as failed (failed audits are not charged).", "default": 60 }, "locale": { "title": "Report language", "type": "string", "description": "Locale for audit titles, e.g. en-US, en-GB, de, fr, es.", "default": "en-US" } } }, "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 } } } } } } } } } }