{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed & Website Health Audit: Lighthouse, Web Vitals", "description": "Test hundreds of websites with Google Lighthouse: performance, SEO, accessibility scores, Core Web Vitals and top fixes, plus a health check (HTTPS, SSL expiry, mobile-ready, title, platform, copyright year) and a ready-to-pitch problem summary per site. No API key needed.", "version": "1.0", "x-build-id": "9Vu3k634F3dYW4OwD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/southern-data~website-speed-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-southern-data-website-speed-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/southern-data~website-speed-audit/runs": { "post": { "operationId": "runs-sync-southern-data-website-speed-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/southern-data~website-speed-audit/run-sync": { "post": { "operationId": "run-sync-southern-data-website-speed-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": { "websites": { "title": "Websites or pages", "type": "array", "description": "One per line: \"acmeplumbing.com.au\" (its homepage is tested), a full page link (\"https://acme.com/services\", tested as given) or an email address (its website is tested). Duplicates are removed. Facebook / Instagram / directory links are not websites and are listed as rowStatus=invalid_input (free).", "items": { "type": "string" } }, "websitesFileUrl": { "title": "…or a link to a list (CSV / TXT / Google Sheet)", "type": "string", "description": "Public URL of a .txt or .csv file, or a Google Sheets link shared as \"Anyone with the link can view\". Uses the column headed website / url / domain / homepage (or the column with the most websites). Columns named name / phone / email are carried into the output so the results are ready to pitch. Up to 100,000 rows." }, "datasetId": { "title": "…or an Apify dataset ID (e.g. from Local Business Leads)", "type": "string", "description": "Pick (or paste the ID of) a dataset from another run, e.g. Local Business Leads from OpenStreetMap or Website Contact Finder. Each row's website is tested and its name / phone / email are carried over. Rows without a website are skipped (free). This Actor only gets read access to the dataset you choose." }, "mode": { "title": "What to check", "enum": [ "full", "health-only" ], "type": "string", "description": "\"full\": Google Lighthouse speed test (scores, Core Web Vitals, top fixes) plus the website health check. \"health-only\": no browser, just the quick health check (HTTPS, certificate, mobile viewport, title, meta description, H1, noindex, platform, copyright year, analytics, response time) — about 17x cheaper and works at 512 MB memory, good for filtering a big lead list first.", "default": "full" }, "devices": { "title": "Speed test on", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Mobile is what Google uses for ranking and what most small-business visitors use. \"both\" runs two tests per page (charged as two).", "default": "mobile" }, "googleApiKey": { "title": "Your Google API key (optional)", "type": "string", "description": "Optional. With your own free Google API key (Google Cloud → enable \"PageSpeed Insights API\" → Credentials → API key), tests run on Google's PageSpeed Insights servers — the same test pagespeed.web.dev runs — and add real-visitor Core Web Vitals from the Chrome UX Report. Cheaper per test ($0.005), because Google does the work. Not yet tested by us with a real key. Google's free quota is 25,000 tests a day per key. Without a key, Lighthouse runs in Chrome on the Apify cloud (lab data only)." }, "maxWebsites": { "title": "Max pages (0 = all)", "minimum": 0, "type": "integer", "description": "Test only the first N pages — handy for a cheap trial on a big file. The rest are skipped (not charged) and listed in the REMAINING record.", "default": 0 }, "selfTest": { "title": "Self-test (health check of this tool)", "type": "boolean", "description": "Ignore the inputs above and run the built-in check instead: scoring rules, a health check and a real Lighthouse test of a built-in page, and two live sites. Writes a SELF_TEST record, adds no dataset rows, charges nothing, and FAILS the run if anything is broken.", "default": false } } }, "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 } } } } } } } } } }