{ "openapi": "3.0.1", "info": { "title": "Website Change Monitor", "description": "Watch any web page and get told exactly what changed since the last run: the added and removed lines, a change percentage, and a status of changed, unchanged or first_run. CSS selectors narrow the watched region and ignore clocks, carousels and ad slots.", "version": "0.1", "x-build-id": "CldwIeZtOYVEuU3ck" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~website-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-website-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/spookyweb~website-change-monitor/runs": { "post": { "operationId": "runs-sync-spookyweb-website-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/spookyweb~website-change-monitor/run-sync": { "post": { "operationId": "run-sync-spookyweb-website-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": [ "urls" ], "properties": { "urls": { "title": "Pages to watch", "type": "array", "description": "The web pages to watch. Add them one at a time, or point at a text file holding one URL per line. Each page is fetched, compared against what it looked like on the previous run, and reported as changed, unchanged or first_run. Every page is charged once per run whatever the outcome.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "contentSelector": { "title": "Watched region", "type": "string", "description": "A CSS selector for the only part of the page that matters, for example main#content or .product-price. Leave it empty to watch the whole page body. If the selector matches nothing the run reports an error for that URL rather than quietly falling back to the whole page, because a silent fallback would look like the entire page had changed.", "default": "" }, "ignoreSelectors": { "title": "Regions to ignore", "type": "array", "description": "CSS selectors for the parts of the page that change on their own: clocks, session or CSRF tokens, view counters, rotating carousels, cookie banners and ad slots. Everything matching these is removed before anything is compared, so it can never trigger a false change. One selector per entry, for example .timestamp or #ad-slot-top.", "default": [], "items": { "type": "string" } }, "changeThreshold": { "title": "Change threshold, percent", "minimum": 0, "maximum": 100, "type": "integer", "description": "How much of the watched content has to differ before it is reported as a change, measured as a percentage of characters. Leave it at 0 to report every difference. Raise it to 5 or 10 on a page that carries small unavoidable churn you cannot name with an ignore selector. A difference under the threshold does not become the new baseline, so a page drifting slowly keeps adding up until it is worth reporting.", "default": 0 }, "mode": { "title": "What counts as content", "enum": [ "text", "html" ], "type": "string", "description": "Compare the visible text, or compare the underlying HTML. Text is the right answer almost always: it ignores markup churn from a template or a CDN rebuild and only reports what a reader would see change. Use HTML when you need to catch an attribute, a link target or a hidden field moving.", "default": "text" }, "storeSnapshot": { "title": "Keep a copy of each page", "type": "boolean", "description": "Save the watched content of every page into this run's key-value store, so you can read exactly what the page said at the moment it was checked. Turn it off to keep runs lean. The comparison itself works either way, because the state used for the next run is kept separately and is never affected by this setting.", "default": true }, "maxRequestRetries": { "title": "Retries per page", "minimum": 0, "maximum": 10, "type": "integer", "description": "How many times to retry a page that times out or answers with a server error, before giving up and reporting it as an error row. Retries back off between attempts. A page that could not be read is never recorded as a change, so a flaky site cannot produce a false alert.", "default": 3 } } }, "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 } } } } } } } } } }