{ "openapi": "3.0.1", "info": { "title": "Bulk Core Web Vitals Monitor (PageSpeed + CrUX)", "description": "Bulk PageSpeed + CrUX monitor for hundreds of URLs. Get alerted when your speed app stops working: history, regression alerts, a warning when Lighthouse scores well but real users fail Core Web Vitals, competitor benchmarks, Slack/webhook alerts. No monthly plan: pay per URL.", "version": "0.1", "x-build-id": "uyu1fbWxkAudPBekA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mrdexter4~core-web-vitals-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mrdexter4-core-web-vitals-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/mrdexter4~core-web-vitals-monitor/runs": { "post": { "operationId": "runs-sync-mrdexter4-core-web-vitals-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/mrdexter4~core-web-vitals-monitor/run-sync": { "post": { "operationId": "run-sync-mrdexter4-core-web-vitals-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": [ "urls" ], "properties": { "urls": { "title": "URLs to audit", "type": "array", "description": "Pages to test (homepage, category, product, landing pages …). One PageSpeed audit per URL per strategy.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "strategy": { "title": "Device strategy", "enum": [ "mobile", "desktop", "both" ], "type": "string", "description": "Mobile, desktop, or both (both = two audits per URL).", "default": "mobile" }, "competitorUrls": { "title": "Competitor URLs (optional)", "type": "array", "description": "Competitor pages to benchmark against. Each is audited too, and every own URL gets a rank and its gap to the best competitor.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "pageSpeedApiKey": { "title": "Google API key (optional, recommended)", "type": "string", "description": "Free key from Google Cloud with the PageSpeed Insights API and Chrome UX Report API enabled. Without a key the Actor uses Google's tiny shared keyless quota and falls back to running Lighthouse itself (lab data only, no CrUX)." }, "includeCrux": { "title": "Include CrUX field data (real users)", "type": "boolean", "description": "Query the Chrome UX Report API for 28-day p75 LCP, INP, CLS, FCP and TTFB (URL level, falling back to origin). Needs an API key; skipped gracefully otherwise.", "default": true }, "includeCruxHistory": { "title": "Include CrUX 6-month history", "type": "boolean", "description": "Also fetch ~25 weekly p75 data points from the CrUX History API (LCP, INP, CLS) to show trends. Needs an API key.", "default": false }, "engine": { "title": "Audit engine", "enum": [ "auto", "pagespeed", "local" ], "type": "string", "description": "Auto = PageSpeed Insights API, falling back to local Lighthouse when Google's quota is exhausted. PageSpeed only = never fall back. Local = always run Lighthouse inside the Actor (no Google quota, lab data only).", "default": "auto" }, "alertThresholds": { "title": "Alert thresholds", "type": "object", "description": "Pass/fail per metric. Defaults are Google's \"good\" thresholds. LCP/CLS use field data when available, else lab; INP is field-only; performance score is lab.", "default": { "lcpMs": 2500, "inpMs": 200, "cls": 0.1, "performanceScore": 90 } }, "historyMode": { "title": "Keep history & detect regressions", "type": "boolean", "description": "Store each result in a named key-value store and output deltas vs the previous run, plus regressions/improvements. Schedule the Actor daily or weekly to monitor.", "default": true }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Named key-value store used for history. Use different names for separate projects/clients.", "default": "cwv-monitor-history" }, "regressionScoreDrop": { "title": "Regression: score drop (points)", "minimum": 1, "type": "integer", "description": "Flag a regression when the performance score drops by at least this many points vs the previous run.", "default": 5 }, "regressionMetricPct": { "title": "Regression: metric worsening (%)", "minimum": 1, "type": "integer", "description": "Flag a regression when LCP, TBT, CLS or INP gets worse by at least this percentage (with small absolute minimums to ignore noise).", "default": 15 }, "webhookUrl": { "title": "Alert webhook URL (optional)", "type": "string", "description": "POST a JSON alert (with a Slack-compatible \"text\" field) when there are alerts. Works with Slack incoming webhooks, Discord (/slack), Zapier, Make and n8n." }, "alertOn": { "title": "Send alerts for", "enum": [ "regressions", "threshold-failures", "both" ], "type": "string", "description": "Which events trigger the webhook.", "default": "regressions" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel PageSpeed requests. Default 6 with an API key, 2 without. Local Lighthouse runs one at a time." }, "locale": { "title": "Lighthouse locale", "type": "string", "description": "Language of opportunity titles from PageSpeed Insights (e.g. en, nl, de).", "default": "en" } } }, "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 } } } } } } } } } }