{ "openapi": "3.0.1", "info": { "title": "Lighthouse Audit", "description": "Run Lighthouse lab audits for public web pages on mobile or desktop profiles. Get category scores, lab metrics, audit findings, and optional HTML, JSON, or CSV reports in your dataset.", "version": "1.0", "x-build-id": "ad8MVzCPIRtELjZFg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~lighthouse-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-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/maximedupre~lighthouse-audit/runs": { "post": { "operationId": "runs-sync-maximedupre-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/maximedupre~lighthouse-audit/run-sync": { "post": { "operationId": "run-sync-maximedupre-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", "required": [ "urls" ], "properties": { "urls": { "title": "Public URLs", "minItems": 1, "type": "array", "description": "Add one or more public HTTP(S) URLs. Each URL gets an audit with the same settings. Pages that need a login are not supported.", "items": { "type": "object", "properties": { "url": { "title": "URL", "type": "string", "description": "Enter a full public HTTP(S) URL, such as https://example.com.", "pattern": "^https?:\\/\\/\\S+$" } }, "required": [ "url" ] } }, "deviceProfiles": { "title": "Device profiles", "minItems": 1, "type": "array", "description": "Choose Mobile, Desktop, or both. Choosing both runs each URL twice and adds a side-by-side comparison when the results are available.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "minItems": 1, "type": "array", "description": "Choose the categories to score. Performance, accessibility, best practices, and SEO are available.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "measurementMethod": { "title": "Measurement conditions", "enum": [ "simulate", "devtools", "provided" ], "type": "string", "description": "Simulated estimates page speed under the chosen network profile. Browser-throttled applies that profile in the browser. Real network uses the network as it is and ignores Network profile. All results are lab measurements and can vary between runs.", "default": "simulate" }, "networkProfile": { "title": "Network profile", "enum": [ "mobileSlow4G", "mobileFast4G", "desktopDense4G", "unthrottled" ], "type": "string", "description": "Choose the network limits for Simulated or Browser-throttled measurements. Unthrottled uses no set network limit. This applies to every selected device profile and is ignored for Real network measurements.", "default": "mobileSlow4G" }, "reportFormats": { "title": "Optional reports", "type": "array", "description": "Choose files to create and store for download. HTML is for reading, JSON is for code, and CSV is for spreadsheets. ZIP contains offline MHTML reports. Leave this empty for dataset results only.", "items": { "type": "string", "enum": [ "html", "json", "csv", "zip" ], "enumTitles": [ "HTML audit report", "Machine-readable JSON report", "CSV summary", "ZIP with offline MHTML reports" ] }, "default": [] }, "regressionThreshold": { "title": "Score-drop threshold", "minimum": 0, "maximum": 100, "type": "integer", "description": "Flag a regression when a category score drops by more than this many points on the 0 to 100 scale. Use 0 to flag any drop. A prior audit of the same page and device must be available.", "default": 0 } } }, "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 } } } } } } } } } }