{ "openapi": "3.0.1", "info": { "title": "Bulk Lighthouse & Core Web Vitals Auditor", "description": "Bulk Google Lighthouse audits of public URLs, mobile and/or desktop: Performance, Accessibility, Best Practices and SEO scores, lab Core Web Vitals (LCP, CLS, TBT), top opportunities and an HTML report per audit. One JSON row per URL and device. Failed audits free.", "version": "1.0", "x-build-id": "mqiWT79Rbsl5qAC52" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thriving_adder~bulk-lighthouse-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thriving_adder-bulk-lighthouse-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/thriving_adder~bulk-lighthouse-auditor/runs": { "post": { "operationId": "runs-sync-thriving_adder-bulk-lighthouse-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/thriving_adder~bulk-lighthouse-auditor/run-sync": { "post": { "operationId": "run-sync-thriving_adder-bulk-lighthouse-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Public http(s) pages to audit, max 2,000 per run. Each item is {\"url\": \"https://...\"}; plain strings and URLs without a scheme (example.com) are also accepted. Duplicates are removed. Login-protected, localhost and private-network URLs are rejected and not charged.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "devices": { "title": "Devices", "type": "array", "description": "Which Lighthouse presets to run for every URL: \"mobile\" (Moto G Power, slow 4G, simulated throttling, like PageSpeed Insights mobile) and/or \"desktop\". Each device is a separate audit and row; the second device for the same URL is billed at the cheaper second-device price.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile (Moto G Power, slow 4G)", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Categories", "type": "array", "description": "Lighthouse categories to score: performance, accessibility, best-practices, seo. Fewer categories run faster. Unknown values are ignored; an empty list runs all four.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "throttlingMethod": { "title": "Throttling", "enum": [ "simulate", "provided" ], "type": "string", "description": "\"simulate\" (default) gives numbers comparable with PageSpeed Insights. \"provided\" applies no throttling and reports raw speed from Apify's servers.", "default": "simulate" }, "saveHtmlReport": { "title": "Save HTML report", "type": "boolean", "description": "Save the full interactive Lighthouse HTML report for every audit to the run's key-value store and link it in the reportUrl field.", "default": true }, "saveJsonReport": { "title": "Save full JSON (LHR)", "type": "boolean", "description": "Also save the complete Lighthouse JSON result (LHR, about 0.5-2 MB each) and link it in jsonReportUrl. Useful for custom analysis.", "default": false }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs whose robots.txt disallows automated agents (our token: LighthouseAuditBot). Skipped URLs are free and returned with errorCode ROBOTS_DISALLOWED.", "default": true }, "maxConcurrency": { "title": "Parallel audits", "minimum": 1, "maximum": 2, "type": "integer", "description": "Audits run in parallel (1 or 2). 1 gives the most stable performance scores. For 2, set the run memory to 8 GB (each audit needs about 4 GB / 1 vCPU).", "default": 1 }, "pageTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 15, "maximum": 120, "type": "integer", "description": "Maximum wait for the page to load in each audit (Lighthouse maxWaitForLoad). Pages that never finish loading fail with a free error row.", "default": 60 } } }, "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 } } } } } } } } } }