{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed Insights Checker: Core Web Vitals & Lighthouse", "description": "Check hundreds of URLs with Google PageSpeed Insights: Lighthouse performance, accessibility, best practices and SEO scores, LCP, CLS, INP, TBT, FCP, TTFB, real-user Core Web Vitals (CrUX) and top fixes. Mobile and desktop. Bring your own free API key for big lists.", "version": "0.1", "x-build-id": "DtCY7vx2zVf2yJIOf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/latamdatatools~pagespeed-bulk-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-latamdatatools-pagespeed-bulk-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/latamdatatools~pagespeed-bulk-checker/runs": { "post": { "operationId": "runs-sync-latamdatatools-pagespeed-bulk-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/latamdatatools~pagespeed-bulk-checker/run-sync": { "post": { "operationId": "run-sync-latamdatatools-pagespeed-bulk-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs to check", "type": "array", "description": "One page URL per line. \"https://\" is added if missing. Duplicates are removed.", "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemap URLs (optional)", "type": "array", "description": "Optional: sitemap.xml or sitemap index URLs. Page URLs found in them are added to the list (up to the limit below).", "items": { "type": "string" } }, "maxUrlsFromSitemaps": { "title": "Max URLs taken from sitemaps", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Upper limit of page URLs read from all sitemaps together.", "default": 50 }, "strategy": { "title": "Device", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Mobile, desktop or both. \"Both\" produces two rows (and two analyses) per URL.", "default": "mobile" }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Which Lighthouse scores to compute. Core Web Vitals, lab metrics and opportunities come with \"performance\".", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ], "enumTitles": [ "Performance", "Accessibility", "Best practices", "SEO" ] }, "default": [ "performance", "accessibility", "best-practices", "seo" ] }, "apiKey": { "title": "Your Google API key (recommended for large lists)", "type": "string", "description": "Optional. A free Google Cloud API key with the PageSpeed Insights API enabled (no billing needed, about 25,000 checks per day). Without it the Actor uses its shared key, limited to 200 analyses per run and shared by all users. See the README for the 2-minute setup." }, "maxOpportunities": { "title": "Opportunities per URL", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many of the biggest performance problems (with estimated savings) to include per row. 0 = none.", "default": 5 }, "compareWithPreviousRun": { "title": "Compare with previous run (monitoring)", "type": "boolean", "description": "Stores the scores of each URL in the named key-value store \"pagespeed-history\" and adds score changes and a regression flag on the next run. Use it with a schedule.", "default": false }, "regressionThreshold": { "title": "Regression threshold (points)", "minimum": 1, "maximum": 100, "type": "integer", "description": "A row is flagged as a regression when the performance score dropped by at least this many points since the previous run.", "default": 10 }, "locale": { "title": "Language of audit titles", "type": "string", "description": "Language for opportunity titles, e.g. en, es, pt-BR, de, fr.", "default": "en" }, "maxConcurrency": { "title": "Parallel checks", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many URLs are analysed at the same time. Each check takes 10-40 s at Google. Capped at 3 with the shared key and at 8 with your own key.", "default": 3 } } }, "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 } } } } } } } } } }