{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed Insights & Core Web Vitals Checker", "description": "Audit hundreds of URLs with Google PageSpeed Insights / Lighthouse in one run. Get performance, accessibility, SEO and best-practices scores, LCP, CLS, TBT, FCP, INP field data and the top fix-it opportunities for mobile and desktop.", "version": "0.1", "x-build-id": "q4a3BwC7sPOuGiusg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datawright-labs~pagespeed-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datawright-labs-pagespeed-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/datawright-labs~pagespeed-auditor/runs": { "post": { "operationId": "runs-sync-datawright-labs-pagespeed-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/datawright-labs~pagespeed-auditor/run-sync": { "post": { "operationId": "run-sync-datawright-labs-pagespeed-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 to audit", "type": "array", "description": "Pages to test. One URL per line. URLs without a scheme get https:// added.", "default": [ "https://example.com" ], "items": { "type": "string" } }, "strategies": { "title": "Device strategy", "type": "array", "description": "Test as a mobile device, desktop, or both. Each URL is audited once per selected strategy (and billed per audit).", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Which Lighthouse category scores to compute. Fewer categories = slightly faster audits.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "apiKey": { "title": "Google API key (optional, recommended)", "type": "string", "description": "Your own free Google Cloud API key with the PageSpeed Insights API enabled. With a key the Actor calls the official PSI API (Google's servers, includes Chrome UX Report field data such as real-user INP). Without a key the Actor uses Google's shared keyless quota when available, otherwise it runs Lighthouse inside the Actor." }, "engine": { "title": "Engine", "enum": [ "auto", "psi", "local" ], "type": "string", "description": "auto = PSI API when a key is given (or the keyless quota is free), otherwise local Lighthouse. psi = always use the PSI API. local = always run Lighthouse inside the Actor (no field data).", "default": "auto" }, "includeFieldData": { "title": "Include real-user (CrUX) field data", "type": "boolean", "description": "When using the PSI API, include Chrome UX Report p75 LCP, INP, CLS, FCP and TTFB for the page (or origin as a fallback). Not available in local Lighthouse mode.", "default": true }, "maxOpportunities": { "title": "Top opportunities per audit", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many improvement opportunities (sorted by estimated time saved) to include per result.", "default": 5 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel audits. Leave empty for the automatic default: 10 in PSI API mode (max 20); in local Lighthouse mode one audit per CPU core (Apify gives 1 core per 4 GB of run memory), because a starved CPU distorts performance scores." }, "maxRetries": { "title": "Max retries per URL", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for transient failures (timeouts, rate limits, 5xx). Permanent errors such as invalid URLs or DNS failures are not retried.", "default": 2 }, "locale": { "title": "Report locale", "type": "string", "description": "Language for audit titles, e.g. en, de, fr, es.", "default": "en" }, "timeoutSecs": { "title": "Per-audit timeout (seconds)", "minimum": 30, "maximum": 300, "type": "integer", "description": "Maximum time to wait for a single audit.", "default": 90 } } }, "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 } } } } } } } } } }