{ "openapi": "3.0.1", "info": { "title": "Website Health & Performance Monitor: Uptime, Speed, Resources", "description": "Monitor a website's health in one call: uptime and timings, a resource waterfall and page weight, a performance score with fixes, history across runs to catch deterioration, and an overall verdict. Schedule + webhook for alerts. Optional real Lighthouse with your own PageSpeed key. Keyless core.", "version": "0.1", "x-build-id": "Jrdq0DyhQdPWVyZVz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/centorprat~website-health-performance-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-centorprat-website-health-performance-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/centorprat~website-health-performance-monitor/runs": { "post": { "operationId": "runs-sync-centorprat-website-health-performance-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/centorprat~website-health-performance-monitor/run-sync": { "post": { "operationId": "run-sync-centorprat-website-health-performance-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", "properties": { "urls": { "title": "🩺 URLs to monitor", "type": "array", "description": "Pages to check, e.g. [\"https://your-site.com\"]. One health report per URL. Schedule the Actor (e.g. every 5-15 min) to build history and catch problems.", "items": { "type": "string" } }, "auditResources": { "title": "Audit page resources (waterfall + page weight)", "type": "boolean", "description": "Fetch the scripts, styles and images the page references and measure their size and load time. Turn off for a lightweight uptime-only check.", "default": true }, "maxResources": { "title": "Max resources to audit per page", "minimum": 1, "maximum": 150, "type": "integer", "description": "Cap how many referenced resources to fetch.", "default": 40 }, "slowLoadMs": { "title": "Flag as slow above (ms)", "minimum": 200, "maximum": 60000, "type": "integer", "description": "Load times above this are flagged 'slow'.", "default": 3000 }, "persistHistory": { "title": "Remember history across runs (deterioration + rollups)", "type": "boolean", "description": "Store each run's snapshot in a named key-value store so the Actor can roll up per day/week/month and flag deterioration vs the recent baseline.", "default": true }, "pageSpeedApiKey": { "title": "PageSpeed Insights API key (optional, for real Lighthouse)", "type": "string", "description": "Paste your own free Google PageSpeed Insights API key to also run a REAL Lighthouse audit (performance score + Core Web Vitals). Left blank, the Actor uses its keyless synthetic score instead." }, "strategy": { "title": "Lighthouse strategy", "enum": [ "mobile", "desktop" ], "type": "string", "description": "mobile or desktop (only used when a PageSpeed key is set).", "default": "mobile" }, "onlyProblems": { "title": "Only output sites needing attention", "type": "boolean", "description": "On: return only down/slow/deteriorating sites (ideal for scheduled alerting).", "default": false }, "webhookUrl": { "title": "Webhook URL (alerts)", "type": "string", "description": "If set, sites that are down/slow/deteriorating are POSTed here as JSON - wire it to Slack/email via Make or Zapier." }, "expectedText": { "title": "Expected text on the page (optional)", "type": "string", "description": "If set, the Actor checks the page HTML contains this text and flags 'content-mismatch' if it's missing - catches pages that return 200 but are broken, empty or defaced." } } }, "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 } } } } } } } } } }