{ "openapi": "3.0.1", "info": { "title": "PageSpeed Insights - Core Web Vitals & Real User Metrics", "description": "PageSpeed Insights actor uses Google's PageSpeed Insights API to get:\nReal-World Field Data from Chrome UX Report (CrUX)\nLab Data from Lighthouse\nCore Web Vitals - LCP, FID/INP, CLS, FCP, TTFB, TBT\nPerformance Scores - 0-100 scores for Performance, Accessibility, Best Practices, SEO\nMobile & Desktop", "version": "1.2", "x-build-id": "nvgIR0ekshhijcc2h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~pagespeed-insights/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-pagespeed-insights", "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/alizarin_refrigerator-owner~pagespeed-insights/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-pagespeed-insights", "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/alizarin_refrigerator-owner~pagespeed-insights/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-pagespeed-insights", "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": { "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Return two sample rows for example.com (no API calls) to see the output format. Each row is marked demo: true. No analysis is charged; the actor start fee still applies.", "default": false }, "urls": { "title": "URLs to Analyze", "type": "array", "description": "List of URLs to analyze with PageSpeed Insights", "items": { "type": "string" } }, "url": { "title": "Single URL", "type": "string", "description": "Single URL to analyze (use this OR urls array)" }, "strategy": { "title": "Strategy", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Device strategy for analysis", "default": "mobile" }, "categories": { "title": "Audit Categories", "type": "array", "description": "Which Lighthouse categories to run", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo", "pwa" ] }, "default": [ "performance", "accessibility", "seo", "best-practices" ] }, "apiKey": { "title": "Google API Key (Optional)", "type": "string", "description": "Your free Google PageSpeed Insights API key. Get one at https://developers.google.com/speed/docs/insights/v5/get-started (click Get a Key). If you leave it empty, the actor uses its own shared key when one is available. With no key at all, the run saves one notice row that explains how to get one, and no analysis is charged." }, "includeFieldData": { "title": "Include Field Data (CrUX)", "type": "boolean", "description": "Include Chrome UX Report real-user data when available", "default": true }, "includeLabData": { "title": "Include Lab Data (Lighthouse)", "type": "boolean", "description": "Include Lighthouse lab test results", "default": true }, "includeOpportunities": { "title": "Include Opportunities", "type": "boolean", "description": "Include performance improvement suggestions", "default": true }, "includeDiagnostics": { "title": "Include Diagnostics", "type": "boolean", "description": "Include detailed diagnostic information", "default": true }, "includeScreenshots": { "title": "Include Screenshots", "type": "boolean", "description": "Include visual screenshots from the audit", "default": false }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to POST results when analysis completes (Zapier, Make, n8n, custom endpoint)" } } }, "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 } } } } } } } } } }