{ "openapi": "3.0.1", "info": { "title": "Clean Screenshot & Change Monitor", "description": "Clean website screenshots without cookie banners, popups or chat widgets. Desktop, mobile and tablet in one run, PDF export, and a change monitor that tells you when a page changed (pixels + text).", "version": "0.1", "x-build-id": "S5bwcUCbIVRJMfWD2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/loris-barce~clean-screenshot-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-loris-barce-clean-screenshot-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/loris-barce~clean-screenshot-monitor/runs": { "post": { "operationId": "runs-sync-loris-barce-clean-screenshot-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/loris-barce~clean-screenshot-monitor/run-sync": { "post": { "operationId": "run-sync-loris-barce-clean-screenshot-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", "type": "array", "description": "Pages to capture (max 500 per run). You can also load a list of URLs from a remote text file.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "devices": { "title": "Devices", "type": "array", "description": "Capture each URL on these devices. Desktop is 1920x1080, mobile is an iPhone 15 profile, tablet is an iPad (7th gen) profile.", "items": { "type": "string", "enum": [ "desktop", "mobile", "tablet" ], "enumTitles": [ "Desktop (1920x1080)", "Mobile (iPhone)", "Tablet (iPad)" ] }, "default": [ "desktop" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of just the visible viewport.", "default": true }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "Image format, or PDF. PDF is only produced for the desktop device; other devices are skipped when PDF is selected.", "default": "png" }, "cleanPage": { "title": "Clean page", "type": "boolean", "description": "Dismiss cookie consent banners (OneTrust, Cookiebot, Didomi, Iubenda, Quantcast, TrustArc, Usercentrics and more), hide popups/overlays and chat widgets before capturing.", "default": true }, "hideSelectors": { "title": "Extra selectors to hide", "type": "array", "description": "CSS selectors of additional elements to hide before capturing (always applied, even when 'Clean page' is off).", "default": [], "items": { "type": "string" } }, "waitFor": { "title": "Wait for", "enum": [ "load", "networkidle", "selector" ], "type": "string", "description": "When the page counts as ready. 'Network idle' is the safest default; 'Selector' waits for the element in 'Wait selector'.", "default": "networkidle" }, "waitSelector": { "title": "Wait selector", "type": "string", "description": "CSS selector to wait for when 'Wait for' is set to 'Selector'." }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Additional wait after the page is ready, for animations and late content.", "default": 1000 }, "monitorMode": { "title": "Change monitor", "type": "boolean", "description": "Compare each screenshot with the one from the previous run and report whether the page changed (pixel diff + visible-text diff). Schedule the Actor to monitor pages over time.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Name of the persistent key-value store that keeps the reference screenshots. Use different names to keep separate monitors apart.", "default": "screenshot-monitor" }, "diffThresholdPercent": { "title": "Change threshold (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Pixel changes below this percentage of the page count as 'no change'. A text change always counts as a change.", "default": 1 }, "ignoreSelectors": { "title": "Ignore selectors", "type": "array", "description": "CSS selectors of areas to ignore in the comparison (e.g. dates, counters, rotating banners). Both their pixels and their text are excluded.", "default": [], "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy. No proxy is used by default.", "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 }, "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 } } } } } } } } } }