{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed & Core Web Vitals Auditor (Lab + CrUX)", "description": "Audit many URLs with Google PageSpeed Insights in one run. Get Lighthouse scores, lab metrics (LCP, CLS, TBT, FCP, Speed Index, TTI) and real-user Chrome UX Report data (LCP, INP, CLS, FCP, TTFB) with pass/fail against Google's thresholds. One flat row per URL and device.", "version": "1.0", "x-build-id": "TJ0MtfIyfThWIC4qa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/birchwood-data~pagespeed-cwv-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-birchwood-data-pagespeed-cwv-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/birchwood-data~pagespeed-cwv-auditor/runs": { "post": { "operationId": "runs-sync-birchwood-data-pagespeed-cwv-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/birchwood-data~pagespeed-cwv-auditor/run-sync": { "post": { "operationId": "run-sync-birchwood-data-pagespeed-cwv-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", "type": "array", "description": "Pages to audit, one per line. 'https://' is added if missing. Duplicates are removed.", "items": { "type": "string" } }, "strategy": { "title": "Device strategy", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Lighthouse device emulation. 'both' runs mobile and desktop and returns two rows per URL (each charged as one audit).", "default": "mobile" }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Which Lighthouse category scores to compute. Fewer categories = faster audits.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "includeFieldData": { "title": "Include real-user field data (CrUX)", "type": "boolean", "description": "Adds Chrome UX Report p75 LCP, INP, CLS, FCP and TTFB at URL and origin level (from PageSpeed Insights) with Google good / needs-improvement / poor ratings. Low-traffic sites often have no field data; then these columns are empty and no field-data charge applies.", "default": true }, "useCruxApi": { "title": "Also query the CrUX API directly", "type": "boolean", "description": "Adds cruxUrl*/cruxOrigin* columns from the Chrome UX Report API (28-day rolling window, includes collection period). Requires an API key with the Chrome UX Report API enabled. Two extra API calls per row.", "default": false }, "googleApiKey": { "title": "Google API key (optional)", "type": "string", "description": "Your own free Google Cloud API key with the PageSpeed Insights API (and optionally Chrome UX Report API) enabled. Uses your quota instead of the shared one. If empty, the Actor uses its GOOGLE_API_KEY environment variable." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel PageSpeed requests (1-10). Each audit takes roughly 10-40 s on Google's side.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 30, "maximum": 180, "type": "integer", "description": "Per-request timeout for the PageSpeed API (30-180). Slow pages may need more.", "default": 90 }, "maxOpportunities": { "title": "Top opportunities / diagnostics to keep", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many opportunities (sorted by estimated savings) and failing diagnostics to include per row.", "default": 5 } } }, "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 } } } } } } } } } }