{ "openapi": "3.0.1", "info": { "title": "Bulk Core Web Vitals & PageSpeed Audit", "description": "Bulk Core Web Vitals and PageSpeed audit: Lighthouse performance, SEO and accessibility scores, LCP, CLS, INP, TBT and the top fixes — one row per URL and device.", "version": "0.1", "x-build-id": "K08CJmlJnbA7IFysC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdatatools~core-web-vitals-audit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdatatools-core-web-vitals-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/webdatatools~core-web-vitals-audit/runs": { "post": { "operationId": "runs-sync-webdatatools-core-web-vitals-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/webdatatools~core-web-vitals-audit/run-sync": { "post": { "operationId": "run-sync-webdatatools-core-web-vitals-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs to audit", "type": "array", "description": "Enter the page URLs to audit, one per row, e.g. https://apify.com. Each URL returns one row per device strategy. Audit the exact URL you care about (a landing page, not only the homepage) - PageSpeed Insights follows redirects but scores the page it lands on.", "default": [ "https://apify.com" ], "items": { "type": "string" } }, "apiKey": { "title": "Google PageSpeed Insights API key", "type": "string", "description": "Paste your free Google PageSpeed Insights API key (https://developers.google.com/speed/docs/insights/v5/get-started), e.g. AIzaSy... Runs of up to 5 URLs work without a key on a shared demo quota; larger batches need your own key (25,000 requests/day, free)." }, "strategy": { "title": "Device strategy", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Select the device Lighthouse should emulate, e.g. mobile. Google ranks on mobile, so audit mobile unless you specifically need desktop numbers. Choose 'Both' to get one row per device (two billable rows per URL).", "default": "mobile" }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Select which Lighthouse categories to score, e.g. performance, seo. Every extra category makes the Google request slower; performance alone already returns all Core Web Vitals and the optimisation opportunities.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance" ] }, "locale": { "title": "Report locale", "type": "string", "description": "Enter the language for Lighthouse titles and display values, e.g. en, de or tr. Only the wording of titles changes, never the metrics.", "default": "en" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Enter how many PageSpeed Insights requests may run in parallel, e.g. 2. Google rate-limits hard and one Lighthouse run takes 10-30 seconds, so keep this at 2-3 unless you have your own API key.", "default": 2 } } }, "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 } } }, "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 } } } } } } } } } }