{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed and Core Web Vitals (Field + Lab Data)", "description": "PageSpeed Insights scores and real-user Core Web Vitals (Chrome UX Report p75 LCP, INP, CLS) for a list of URLs, one row per URL and device, from Google's official APIs with your own free Google API key. URL-level field data, origin fallback labelled.", "version": "0.1", "x-build-id": "XE6vGD59bjtOTt3vc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/madrasco~pagespeed-core-web-vitals-bulk/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-madrasco-pagespeed-core-web-vitals-bulk", "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/madrasco~pagespeed-core-web-vitals-bulk/runs": { "post": { "operationId": "runs-sync-madrasco-pagespeed-core-web-vitals-bulk", "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/madrasco~pagespeed-core-web-vitals-bulk/run-sync": { "post": { "operationId": "run-sync-madrasco-pagespeed-core-web-vitals-bulk", "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 test", "type": "array", "description": "Pages to test, one per line (https://example.com/page); a pasted list separated by spaces or commas is split into separate URLs. A bare domain becomes https:///. Also accepted as 'startUrls' or 'url'.", "items": { "type": "string" } }, "apiKey": { "title": "Google API key", "type": "string", "description": "Your own Google Cloud API key with the 'PageSpeed Insights API' and the 'Chrome UX Report API' enabled (both have a free quota; see the README for the 2-minute setup). Stored encrypted by Apify, sent to Google only in a request header, never logged or written to the results." }, "strategy": { "title": "Device", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Lighthouse device emulation and the matching Chrome UX Report form factor (phone or desktop).", "default": "mobile" }, "dataMode": { "title": "Data to fetch", "enum": [ "both", "field", "lab" ], "type": "string", "description": "Field data comes from the Chrome UX Report API (28-day real-user p75); lab data from a PageSpeed Insights Lighthouse run.", "default": "both" }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Category scores to include (0-100). When lab data is on, Performance is always included: the lab metrics (LCP, FCP, CLS, Total Blocking Time, Speed Index) and the top-issues list come from it. The others add their scores.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance" ] }, "originFallback": { "title": "Fall back to origin-level field data", "type": "boolean", "description": "When the Chrome UX Report has no record for the exact URL, use the whole site's (origin's) record. If neither has data and the page redirects within the same site (e.g. example.com to www.example.com), the address it redirects to is tried too. The 'fieldDataLevel' column says which one you got: url, origin, final_url, final_origin or none.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many URLs are tested at once. Lower it if your key's per-minute quota is small.", "default": 4 }, "topIssues": { "title": "Top performance issues per URL", "minimum": 0, "maximum": 20, "type": "integer", "description": "Failing Lighthouse performance audits to list, largest estimated savings first.", "default": 5 }, "maxUrls": { "title": "Maximum URLs", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on the number of URLs tested in one run.", "default": 500 } } }, "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 } } } } } } } } } }