{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & Visual Change Monitor", "description": "Monitor website visual changes and capture stable PNG screenshots in bulk. Compare every successful render with the last good baseline, get pixel-change ratios, highlighted diffs and changed regions, and send webhook-ready results for QA, ecommerce, compliance and competitor tracking.", "version": "0.1", "x-build-id": "dI3TGSnS3VIuvBZz3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~website-screenshot-visual-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-website-screenshot-visual-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/automa-flow~website-screenshot-visual-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-website-screenshot-visual-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/automa-flow~website-screenshot-visual-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-website-screenshot-visual-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": "Webpages", "minItems": 1, "maxItems": 500, "type": "array", "description": "Public HTTP(S) webpages, up to 500 per run. externalId is echoed into the result so it can join back to your watchlist.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "Public webpage URL", "description": "Anonymous public HTTP(S) page to capture. Private networks, URL credentials and non-HTTP schemes are rejected." }, "externalId": { "type": "string", "title": "Your ID", "description": "Optional watchlist identifier echoed into this URL's result and never sent to the target website." } } } }, "mode": { "title": "Mode", "enum": [ "snapshot", "monitor" ], "type": "string", "description": "Snapshot captures the current page without reading or changing monitoring state. Monitor compares with the last successful capture; its first successful run is BASELINE.", "default": "snapshot" }, "fullPage": { "title": "Full-page screenshot", "type": "boolean", "description": "Capture the complete scrollable page. Disable for a faster above-the-fold viewport screenshot.", "default": true }, "viewport": { "title": "Viewport", "type": "object", "description": "Deterministic browser viewport in CSS pixels. Desktop and mobile settings always use separate monitor baselines.", "properties": { "width": { "type": "integer", "title": "Viewport width", "description": "Browser viewport width in CSS pixels.", "minimum": 320, "maximum": 3840, "default": 1440 }, "height": { "type": "integer", "title": "Viewport height", "description": "Browser viewport height in CSS pixels.", "minimum": 240, "maximum": 2160, "default": 900 } }, "default": { "width": 1440, "height": 900 } }, "waitUntil": { "title": "Page-ready signal", "enum": [ "networkidle", "load", "domcontentloaded" ], "type": "string", "description": "networkidle waits for load and then gives background requests a bounded 8-second settling window. Use load or domcontentloaded on sites with perpetual analytics requests.", "default": "networkidle" }, "delayMs": { "title": "Extra settling delay", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Additional wait after fonts, viewport images, lazy-load scroll and selectors are stabilized.", "default": 500 }, "navigationTimeoutMs": { "title": "Navigation timeout", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Hard per-attempt navigation limit. Transient navigation failures are retried once and retries are never separate output rows.", "default": 45000 }, "scrollForLazyLoad": { "title": "Load lazy page content", "type": "boolean", "description": "For full-page captures, scroll down in bounded steps to load images and sections before returning to the top.", "default": true }, "ignoreSelectors": { "title": "Ignore changing elements", "maxItems": 100, "type": "array", "description": "CSS selectors whose contents are made invisible while their layout space remains. Use for clocks, ads, random recommendations and rotating content.", "items": { "type": "string" }, "default": [] }, "hideSelectors": { "title": "Remove elements", "maxItems": 100, "type": "array", "description": "CSS selectors removed with display:none before capture. Use only when layout reflow is desirable, for example cookie banners or chat widgets.", "items": { "type": "string" }, "default": [] }, "changeThreshold": { "title": "Meaningful visual-change threshold", "minimum": 0, "maximum": 1, "type": "number", "description": "Fraction of changed pixels required for VISUAL_CHANGE. 0.01 means 1% of the normalized common canvas.", "default": 0.01 }, "saveDiffImage": { "title": "Save highlighted diff image", "type": "boolean", "description": "Store one highlighted PNG when a monitor result exceeds the meaningful-change threshold.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional user-controlled Apify or custom proxy. Direct Chromium access is the default; the Actor never escalates automatically to residential proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }