{ "openapi": "3.0.1", "info": { "title": "Lighthouse Audit API", "description": "Run a Lighthouse audit on public URLs and get one JSON row per URL and device: performance, accessibility, best practices and SEO scores, Core Web Vitals (LCP, CLS, TBT), page weight and the top speed fixes. Mobile or desktop.", "version": "0.0", "x-build-id": "0MK5QwjitfjqFZ9te" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/conserving_celerytop~lighthouse-audit-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-conserving_celerytop-lighthouse-audit-api", "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/conserving_celerytop~lighthouse-audit-api/runs": { "post": { "operationId": "runs-sync-conserving_celerytop-lighthouse-audit-api", "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/conserving_celerytop~lighthouse-audit-api/run-sync": { "post": { "operationId": "run-sync-conserving_celerytop-lighthouse-audit-api", "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", "maxItems": 500, "type": "array", "description": "Enter one public page address per line, for example https://example.com/pricing. A missing https:// is added. Each URL is audited once per device, so 10 URLs on both devices are 20 audits.", "items": { "type": "string" } }, "listDatasetId": { "title": "Dataset with the list", "type": "string", "description": "Pick an Apify Dataset that holds your page addresses, one entry per item. They are added to the entries typed above." }, "listDatasetField": { "title": "Field in the dataset", "type": "string", "description": "Name of the dataset field that holds the entry. Leave empty to use the first text field it finds." }, "listFileUrl": { "title": "List file URL", "type": "string", "description": "Web address of a .txt, .csv or .json file with your page addresses, one entry per line. A header row is skipped. Up to 10 MB." }, "strategy": { "title": "Device", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Choose the device to test. Mobile uses the standard Lighthouse phone profile with slow 4G throttling. Both returns two rows per URL.", "default": "mobile" }, "maxOpportunities": { "title": "Top fixes per audit", "minimum": 0, "maximum": 10, "type": "integer", "description": "Return up to this many of the largest speed fixes for each page, ranked by estimated time saved. Enter 0 to leave them out.", "default": 5 }, "saveHtmlReport": { "title": "Save full HTML report", "type": "boolean", "description": "Save the full Lighthouse HTML report for each audit in the run storage and add its link to the row. Turn on to open the report in a browser.", "default": false }, "concurrency": { "title": "Parallel audits", "minimum": 1, "maximum": 4, "type": "integer", "description": "Run this many audits at the same time. Each one uses about 1.5 GB of memory, so the Actor lowers this number when the run has less memory. Scores can differ a little when many audits share one machine.", "default": 2 }, "pageTimeoutSeconds": { "title": "Page timeout (seconds)", "minimum": 20, "maximum": 180, "type": "integer", "description": "Wait up to this many seconds for a page to finish loading before the audit is stopped and an error row is returned.", "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 } } } } } } } } } }