{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed & Core Web Vitals Checker: Lighthouse + CrUX", "description": "Bulk PageSpeed Insights checker: Lighthouse performance, SEO and accessibility scores for many URLs, plus real-user Core Web Vitals (LCP, INP, CLS) from the Chrome UX Report with pass/fail, a 6-month trend and alerts when a page gets worse. Your own free Google API key; demo without one.", "version": "0.1", "x-build-id": "VhIyGbzfyCKnZgmi1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stellalytics~core-web-vitals-pagespeed-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stellalytics-core-web-vitals-pagespeed-checker", "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/stellalytics~core-web-vitals-pagespeed-checker/runs": { "post": { "operationId": "runs-sync-stellalytics-core-web-vitals-pagespeed-checker", "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/stellalytics~core-web-vitals-pagespeed-checker/run-sync": { "post": { "operationId": "run-sync-stellalytics-core-web-vitals-pagespeed-checker", "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 test", "type": "array", "description": "Pages to test, one per line. Bare domains get https:// added. Each URL and device is one PageSpeed test. At most 2,000 URLs per run.", "items": { "type": "string" } }, "googleApiKey": { "title": "Google API key", "type": "string", "description": "Your own free Google API key with the PageSpeed Insights API enabled (and the Chrome UX Report API for field-data trends). Create one in Google Cloud Console under APIs & Services, Credentials. No billing account is needed. Leave empty for a free demo on a sample report. The key is sent only to Google." }, "strategies": { "title": "Devices", "type": "array", "description": "Test as a mobile phone, a desktop, or both. Each device is a separate test and result row.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Scores to compute. Performance is always included.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "includeTrend": { "title": "Field-data trend (6 months)", "type": "boolean", "description": "Add the weekly 75th-percentile history of real-user LCP, INP, CLS, FCP and TTFB from the CrUX History API (about 6 months), and whether each is improving or worsening. Needs the Chrome UX Report API enabled for your key. Free.", "default": true }, "trackChanges": { "title": "Compare with the previous run", "type": "boolean", "description": "Remember each page's results in a named key-value store in your Apify account and report changes and alerts (for example Core Web Vitals now failing, or a score drop of 10 points) on the next run. Made for scheduled runs.", "default": true }, "historyName": { "title": "History name", "type": "string", "description": "Keep separate histories for different schedules or clients. Letters, digits, '-' and '_'.", "default": "default" }, "maxConcurrency": { "title": "Parallel tests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many PageSpeed tests run at once. Google's free default quota is about 400 tests per 100 seconds and 25,000 per day per Google Cloud project.", "default": 6 } } }, "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 } } } } } } } } } }