{ "openapi": "3.0.1", "info": { "title": "Bulk Lighthouse & Core Web Vitals Audit with Budgets", "description": "Run real Google Lighthouse on hundreds of pages or a whole sitemap, on mobile and desktop. Get performance, accessibility, SEO scores and Core Web Vitals (LCP, CLS, TBT) with pass/fail budgets. No API key needed.", "version": "1.0", "x-build-id": "wB5md39bKYD4cjMc2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/creativefour~lighthouse-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-creativefour-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/creativefour~lighthouse-audit/runs": { "post": { "operationId": "runs-sync-creativefour-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/creativefour~lighthouse-audit/run-sync": { "post": { "operationId": "run-sync-creativefour-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 to audit", "type": "array", "description": "One page per line. A missing scheme is treated as https.", "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemaps to expand", "type": "array", "description": "Sitemap or sitemap-index URLs; every page they list is audited (up to Max URLs).", "items": { "type": "string" } }, "device": { "title": "Device", "enum": [ "both", "mobile", "desktop" ], "type": "string", "description": "Lighthouse's official mobile emulation (throttled 4G, mid-range phone), desktop, or both. Each URL and device is one result.", "default": "both" }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Performance is always included. Fewer categories run faster.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "onlyFailures": { "title": "Save only pages that fail a budget", "type": "boolean", "description": "Healthy pages are counted in the summary but not saved, so you aren't charged for them.", "default": false }, "performanceMinScore": { "title": "Budget: minimum performance score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Pages scoring below this (0-100) fail. Google's 'good' band starts at 90.", "default": 90 }, "lcpMaxMs": { "title": "Budget: max Largest Contentful Paint (ms)", "minimum": 0, "type": "integer", "description": "Google's Core Web Vitals 'good' threshold is 2500 ms.", "default": 2500 }, "clsMax": { "title": "Budget: max Cumulative Layout Shift", "minimum": 0, "type": "number", "description": "Google's Core Web Vitals 'good' threshold is 0.1.", "default": 0.1 }, "tbtMaxMs": { "title": "Budget: max Total Blocking Time (ms)", "minimum": 0, "type": "integer", "description": "Lighthouse's lab stand-in for responsiveness (INP). 200 ms or less is good.", "default": 200 }, "maxUrls": { "title": "Max URLs", "minimum": 1, "type": "integer", "description": "Upper limit on pages audited in one run, after sitemap expansion. Each audit takes about 15-40 seconds.", "default": 50 }, "timeoutSecs": { "title": "Timeout per audit (seconds)", "minimum": 30, "maximum": 600, "type": "integer", "description": "A page that takes longer is recorded as an error and the next one starts on a fresh browser.", "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 } } } } } } } } } }