{ "openapi": "3.0.1", "info": { "title": "PageSpeed & Core Web Vitals Monitor (own Google API key)", "description": "Bring your own Google API key: bulk PageSpeed and Core Web Vitals (LCP, INP, CLS) for many URLs on mobile and desktop. Monitor mode outputs only pages whose scores or vitals changed. Not affiliated with or endorsed by Google LLC.", "version": "0.1", "x-build-id": "E6X6rZdjnocU5uogQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jwaiworks~pagespeed-cwv-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jwaiworks-pagespeed-cwv-monitor", "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/jwaiworks~pagespeed-cwv-monitor/runs": { "post": { "operationId": "runs-sync-jwaiworks-pagespeed-cwv-monitor", "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/jwaiworks~pagespeed-cwv-monitor/run-sync": { "post": { "operationId": "run-sync-jwaiworks-pagespeed-cwv-monitor", "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": [ "apiKey", "urls" ], "properties": { "apiKey": { "title": "Your Google API key", "type": "string", "description": "Your own key from Google Cloud Console with the PageSpeed Insights API enabled (free; Google's default quota is 25,000 checks a day). Used only for this run: sent only to www.googleapis.com, never stored, logged or shown by the Actor (Apify keeps run input encrypted as a secret field). Tip: restrict the key to the PageSpeed Insights API." }, "urls": { "title": "URLs", "type": "array", "description": "Public pages to test, e.g. https://example.com/pricing.", "items": { "type": "string" } }, "strategies": { "title": "Devices", "type": "array", "description": "Each device is one check.", "items": { "type": "string", "enum": [ "mobile", "desktop" ] }, "default": [ "mobile" ] }, "categories": { "title": "Lighthouse categories", "type": "array", "description": "Extra categories make each check slower.", "items": { "type": "string", "enum": [ "performance", "accessibility", "best-practices", "seo" ] }, "default": [ "performance" ] }, "monitorMode": { "title": "Monitor mode (only changes)", "type": "boolean", "description": "Output only URLs whose scores moved by the threshold or whose Core Web Vitals status changed.", "default": false }, "monitorStateName": { "title": "Monitor name", "type": "string", "description": "Separate monitors keep separate memory.", "default": "default" }, "scoreChangeThreshold": { "title": "Score change threshold (points)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Lab scores vary run to run; smaller moves are ignored.", "default": 5 }, "alertBelowPerformanceScore": { "title": "Flag pages below this performance score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Sets belowThreshold=true on results under this score." }, "maxConcurrency": { "title": "Parallel checks", "minimum": 1, "maximum": 8, "type": "integer", "description": "Each check takes ~10-40 s at Google.", "default": 4 }, "apiBaseUrl": { "title": "API base URL", "type": "string", "description": "Only https://www.googleapis.com is accepted, so your key only goes to Google.", "default": "https://www.googleapis.com" } } }, "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 } } } } } } } } } }