{ "openapi": "3.0.1", "info": { "title": "Website Visual Change Monitor", "description": "📸 Capture public webpages, compare them with persistent visual baselines, quantify changed pixels, and review highlighted PNG diffs with crop and mask controls.", "version": "0.1", "x-build-id": "K1Ty2L4ajEytX85Ob" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~website-visual-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-website-visual-change-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/automation-lab~website-visual-change-monitor/runs": { "post": { "operationId": "runs-sync-automation-lab-website-visual-change-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/automation-lab~website-visual-change-monitor/run-sync": { "post": { "operationId": "run-sync-automation-lab-website-visual-change-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": [ "startUrls", "monitorId" ], "properties": { "startUrls": { "title": "🌐 Public webpage URLs", "type": "array", "description": "Up to 20 anonymous HTTP/HTTPS pages to capture and compare.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "monitorId": { "title": "🔑 Monitor ID", "minLength": 3, "maxLength": 80, "type": "string", "description": "A stable, private identifier for this monitor. Scheduled Actor tasks are additionally isolated by task ID.", "default": "distill-pricing-monitor" }, "viewportWidth": { "title": "Viewport width", "minimum": 320, "maximum": 2560, "type": "integer", "description": "Browser viewport width in CSS pixels.", "default": 1280 }, "viewportHeight": { "title": "Viewport height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height in CSS pixels.", "default": 800 }, "fullPage": { "title": "Capture full page", "type": "boolean", "description": "Capture the complete scrollable page instead of only the viewport.", "default": true }, "waitUntil": { "title": "Navigation wait condition", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Browser lifecycle event to await before the additional delay.", "default": "networkidle" }, "waitAfterLoadMs": { "title": "Extra render delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Additional time for late layout and fonts to settle.", "default": 1000 }, "navigationTimeoutSecs": { "title": "Navigation timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Maximum wait for each page navigation.", "default": 45 }, "cropSelector": { "title": "✂️ Crop CSS selector", "type": "string", "description": "Optional selector for monitoring one page region, such as #pricing. The run reports an error if it matches nothing." }, "maskSelectors": { "title": "Mask CSS selectors", "type": "array", "description": "Elements replaced with a stable black mask in screenshots.", "default": [], "items": { "type": "string" } }, "hideSelectors": { "title": "Hide CSS selectors", "type": "array", "description": "Elements hidden before capture. Use masks when hiding would cause layout reflow.", "default": [], "items": { "type": "string" } }, "pixelThreshold": { "title": "Pixel color tolerance", "minimum": 0, "maximum": 1, "type": "number", "description": "Pixelmatch color-distance tolerance from 0 (strict) to 1 (lenient).", "default": 0.1 }, "changeThresholdPercent": { "title": "Meaningful change threshold (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Set thresholdExceeded when at least this percentage of pixels changed.", "default": 0.1 }, "resetBaseline": { "title": "♻️ Reset baseline", "type": "boolean", "description": "Treat this run as a fresh baseline instead of comparing with the stored image.", "default": false }, "updateBaseline": { "title": "Update baseline after capture", "type": "boolean", "description": "Store each successful current capture as the baseline for the next run. Disable to compare repeatedly against a fixed baseline.", "default": true }, "baselineStoreName": { "title": "Baseline KVS name", "type": "string", "description": "Advanced: named key-value store used for baseline images and metadata.", "default": "website-visual-change-monitor-baselines" }, "proxyConfiguration": { "title": "🌍 Proxy configuration", "type": "object", "description": "Optional Apify Proxy settings for public pages that require a particular geography." } } }, "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 } } }, "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 } } } } } } } } } }