{ "openapi": "3.0.1", "info": { "title": "Website Change Watcher: Page, Sitemap & Feed Monitor", "description": "Website change monitor and price tracker: watch any page, sitemap or feed and get only what changed. Track price and stock with CSS selectors (old, new, difference), quiet hours, no false alarms. Never charges for a failed or empty result.", "version": "0.1", "x-build-id": "sRyZvj1cGeeQMoLfy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pavel.tashev~website-change-watcher/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pavel.tashev-website-change-watcher", "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/pavel.tashev~website-change-watcher/runs": { "post": { "operationId": "runs-sync-pavel.tashev-website-change-watcher", "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/pavel.tashev~website-change-watcher/run-sync": { "post": { "operationId": "run-sync-pavel.tashev-website-change-watcher", "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": [ "targets" ], "properties": { "targets": { "title": "Targets", "maxItems": 500, "type": "array", "description": "Pages, sitemap URLs, feed URLs or domains to watch. Each target is compared with what it looked like on the previous run of this Actor in your account.", "items": { "type": "string" } }, "watchMode": { "title": "What to watch", "enum": [ "auto", "content", "sitemap", "feed" ], "type": "string", "description": "\"Detect automatically\" reads each target and treats it as a page, sitemap or feed. Choose a specific mode to force it; with \"Sitemap\" or \"Feed\" a bare domain is resolved through robots.txt and the usual locations.", "default": "auto" }, "firstRunOutput": { "title": "First check of a target", "enum": [ "none", "all" ], "type": "string", "description": "What to do the first time a target is seen, when there is nothing to compare with. \"Save baseline only\" returns nothing and costs nothing. \"Return a baseline row\" returns one row per target so you can confirm what is being watched.", "default": "none" }, "selector": { "title": "Watch only this part of the page", "type": "string", "description": "Optional CSS selector, for example main, #price, .product-info or .card .title. Only matching parts are compared, which removes noise from menus, banners and footers. Tags, #id, .class and space-separated paths are supported." }, "extract": { "title": "Values to extract (price, stock, number, date)", "type": "array", "description": "Read named values from the page and report old → new with the difference. Each entry is {\"name\": \"price\", \"selector\": \".price\", \"type\": \"price\"}. Type is text, number, price, date or boolean (in stock / sold out). Selectors support tags, #id, .class, [attribute], [attribute=\"value\"], paths with spaces or >, and ::text or ::attr(content) at the end. A selector that matches nothing is reported with status \"empty\" and a reason, never as a silent null." }, "requireConsecutiveChanges": { "title": "Report a change only after this many runs in a row", "minimum": 1, "maximum": 10, "type": "integer", "description": "1 reports a change as soon as it is seen. 2 or more hold it back until the same change is seen that many runs in a row, which filters out A/B tests and rotating banners. A real change is then reported one run later.", "default": 1 }, "quietHours": { "title": "Quiet hours (no checks)", "type": "string", "description": "Optional window when targets are skipped, for example 22:00-07:00. Skipped targets are not fetched and not charged. Use with a schedule that runs often." }, "checkOnlyOnDays": { "title": "Check only on these days", "type": "array", "description": "Optional weekdays when checks may run: mon, tue, wed, thu, fri, sat, sun. Other days are skipped without a request and without a charge.", "items": { "type": "string" } }, "minHoursBetweenChecks": { "title": "Minimum hours between checks", "minimum": 0, "maximum": 720, "type": "integer", "description": "Skip a target that was checked less than this many hours ago. Lets one frequent schedule serve targets that need different rhythms. 0 turns the check off.", "default": 0 }, "timezone": { "title": "Time zone", "type": "string", "description": "Time zone for quiet hours and weekdays: a name such as Europe/Sofia, or an offset such as +02:00. Defaults to UTC.", "default": "UTC" }, "textOnly": { "title": "Compare visible text only", "type": "boolean", "description": "On: compare the text a visitor sees, so markup and attribute changes are ignored. Off: compare the HTML as well, which catches changes in links, images and attributes.", "default": true }, "ignoreVolatileText": { "title": "Ignore clocks, timestamps and \"x minutes ago\"", "type": "boolean", "description": "On: strip times, ISO timestamps, relative dates and request tokens before comparing. These change on every visit and would otherwise report a change every run.", "default": true }, "ignoreNumbers": { "title": "Ignore all numbers", "type": "boolean", "description": "Replace every number before comparing. Useful for pages with view counters or stock levels when you only care about wording. Turn off when you watch prices.", "default": false }, "ignorePatterns": { "title": "Ignore text matching", "type": "array", "description": "Regular expressions removed before comparing, for example Copyright \\d{4} or Cart \\(\\d+\\). Use this for anything that changes on every visit.", "items": { "type": "string" } }, "minChangePercent": { "title": "Minimum change to report (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Report a page only when at least this much of it changed. 0 reports any difference; 5 ignores small edits.", "default": 0 }, "maxItemsPerTarget": { "title": "Maximum URLs or items per target", "minimum": 1, "maximum": 50000, "type": "integer", "description": "For sitemaps and feeds: stop after this many entries. When the limit is reached, removals are not reported, because the missing entries may simply not have been read.", "default": 50000 }, "maxDiffChars": { "title": "Maximum characters of changed text", "minimum": 200, "maximum": 50000, "type": "integer", "description": "Cap for the added and removed text returned per target. Longer changes are cut and marked with diffTruncated.", "default": 5000 }, "shrinkSafetyPercent": { "title": "Shrink safety threshold (%)", "minimum": 0, "maximum": 100, "type": "integer", "description": "If a target returns less than this share of the previous content or entries, the run assumes a block page or a failed download: no change is reported and the saved snapshot is kept. Set 0 to turn the check off.", "default": 30 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip targets that the site's robots.txt disallows. Turn this off only for sites you own.", "default": true }, "concurrency": { "title": "Targets checked in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "Higher is faster across many sites. Requests to the same host are always spaced out.", "default": 5 }, "userAgent": { "title": "User agent", "type": "string", "description": "Optional custom User-Agent header. Leave empty to identify as WebsiteChangeWatcher." } } }, "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 } } } } } } } } } }