{ "openapi": "3.0.1", "info": { "title": "Bulk PageSpeed Insights for a Sitemap", "description": "Run PageSpeed Insights on every URL in a sitemap or a list. Get the performance score and Core Web Vitals for mobile and desktop, one row per URL and device. Uses your own free Google API key. A test that fails comes back as a row that says why. Export to CSV, JSON or Excel.", "version": "0.0", "x-build-id": "g3SxZiideCLuZfisZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bjgomes~bulk-pagespeed-insights-for-a-sitemap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bjgomes-bulk-pagespeed-insights-for-a-sitemap", "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/bjgomes~bulk-pagespeed-insights-for-a-sitemap/runs": { "post": { "operationId": "runs-sync-bjgomes-bulk-pagespeed-insights-for-a-sitemap", "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/bjgomes~bulk-pagespeed-insights-for-a-sitemap/run-sync": { "post": { "operationId": "run-sync-bjgomes-bulk-pagespeed-insights-for-a-sitemap", "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": { "startUrls": { "title": "Websites or sitemap URLs", "type": "array", "description": "Websites or sitemaps whose pages to test, as objects like {\"url\": \"https://example.com\"}. A homepage (or any page) stands for its whole site: its sitemaps are found from robots.txt, /sitemap.xml and /sitemap_index.xml, and every page they list is tested, up to maxUrls. A URL with .xml, .gz or 'sitemap' in its path is read as a sitemap. Give this, 'urls', or both. To test one specific page, use 'urls'.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "urls": { "title": "Page URLs to test", "type": "array", "description": "Specific pages to test exactly as given, as objects like {\"url\": \"https://example.com/pricing\"}. No sitemap is read for these, so one URL here and nothing in startUrls is the quickest run: one test per device, run in parallel, usually 10 to 30 seconds. Tested before any sitemap pages. Give this, 'startUrls', or both.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "apiKey": { "title": "Google API key (PageSpeed Insights API)", "type": "string", "description": "Optional. Your own Google Cloud API key with the PageSpeed Insights API enabled (free to get). Without one, a run tests at most 2 URLs on a shared quota, which can be used up. Stored encrypted by Apify, sent only to Google in a request header, never logged or written to the output." }, "devices": { "title": "Devices", "type": "array", "description": "Which devices to test as: [\"mobile\"], [\"desktop\"] or both (the default). Each URL on each device is one test, and you pay per test.", "items": { "type": "string", "enum": [ "mobile", "desktop" ], "enumTitles": [ "Mobile", "Desktop" ] }, "default": [ "mobile", "desktop" ] }, "maxUrls": { "title": "Maximum URLs", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many unique URLs across all inputs. Tests run = URLs x devices, so this caps the cost. Without an apiKey a run tests at most 2 URLs.", "default": 100 }, "maxOpportunities": { "title": "Opportunities per test", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many of Lighthouse's improvement opportunities to list per test, largest estimated time saving first. 0 leaves them out.", "default": 5 }, "maxConcurrency": { "title": "Tests in flight at once", "minimum": 1, "maximum": 8, "type": "integer", "description": "PageSpeed tests running at once. Google's default quota is far above this; lower it if your key has a small custom limit.", "default": 4 }, "requestTimeoutSecs": { "title": "Test timeout (seconds)", "minimum": 30, "maximum": 300, "type": "integer", "description": "The longest one PageSpeed test may take, start to finish, retries included, before it becomes an error row. A slow page can take a minute.", "default": 120 } } }, "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 } } } } } } } } } }