{ "openapi": "3.0.1", "info": { "title": "PageSpeed Insights Checker", "description": "PageSpeed Insights Checker audits URLs or pages found in a sitemap and returns Lighthouse scores, lab Core Web Vitals, failing audits, and CrUX field data when available. Run mobile or desktop reports, with no API key required by default; you can also use your own PageSpeed Insights API key.", "version": "0.1", "x-build-id": "rDO6PATze58jo5X4o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~pagespeed-insights-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-pagespeed-insights-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/axiomworks~pagespeed-insights-checker/runs": { "post": { "operationId": "runs-sync-axiomworks-pagespeed-insights-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/axiomworks~pagespeed-insights-checker/run-sync": { "post": { "operationId": "run-sync-axiomworks-pagespeed-insights-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": "Page URLs", "type": "array", "description": "Pages to audit, one per line: full URLs (https://www.example.org/pricing) or bare domains (example.org, https:// is added). Needed unless sitemapUrls is given. A page Google can't reach is logged and skipped with no result and no charge.", "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemap URLs", "type": "array", "description": "Optional sitemap.xml or sitemap-index URLs, e.g. https://example.org/sitemap.xml. Their pages are added to the audit list; sitemap indexes are followed up to 2 levels deep, and collecting stops once there are maxItems pages.", "default": [], "items": { "type": "string" } }, "strategies": { "title": "Strategies (devices)", "type": "array", "description": "Which Lighthouse device profiles to run: \"mobile\" (throttled phone) and/or \"desktop\". Default [\"mobile\"]. Each page gives one result per strategy, so both strategies double the results counted against maxItems.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile" ] }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of reports (one page x one strategy) to return across all URLs and sitemaps, 1-10000, default 50. The run stops once this many are saved, and you are charged only for reports returned.", "default": 50 }, "maxFailingAudits": { "title": "Failing audits per report", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many failing Lighthouse audits (score below 90) to list in failingAudits for each report, biggest estimated savings first. 0-50, default 10; 0 leaves the list empty.", "default": 10 }, "includeFieldData": { "title": "Include real-user field data (CrUX)", "type": "boolean", "description": "Add Chrome UX Report p75 values (LCP, INP, CLS, FCP, TTFB) from real users, for the exact URL when Google has them, else for the whole origin. Default true. Small sites often have none; the field metrics are then null.", "default": true }, "maxConcurrency": { "title": "Parallel analyses", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many pages are analysed at the same time, 1-5, default 3. Each analysis takes 10-100 seconds on Google's side.", "default": 3 }, "apiKey": { "title": "PageSpeed Insights API key", "type": "string", "description": "Optional. Your own free PageSpeed Insights API key from Google Cloud. When set, reports come from the official googleapis.com API (one call per page per strategy); if Google rejects the key, the run falls back to the default source. Leave empty to use the default source." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy for requests to PageSpeed Insights and your sitemaps, default Apify Proxy (datacenter). Switch to residential proxies only if runs get rate-limited.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }