{ "openapi": "3.0.1", "info": { "title": "Website Change Monitor & Page Diff Tracker", "description": "Monitor website, SEO, pricing, landing page, documentation, and AI/RAG content changes. Track persistent snapshots, detect significant changes, and export structured page diffs for Apify Schedules, APIs, webhooks, and automations.", "version": "0.1", "x-build-id": "BJ3sMwP4S5mpc9f9q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/joaosbp~website-change-monitor-seo-ai/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-joaosbp-website-change-monitor-seo-ai", "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/joaosbp~website-change-monitor-seo-ai/runs": { "post": { "operationId": "runs-sync-joaosbp-website-change-monitor-seo-ai", "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/joaosbp~website-change-monitor-seo-ai/run-sync": { "post": { "operationId": "run-sync-joaosbp-website-change-monitor-seo-ai", "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" ], "properties": { "startUrls": { "title": "Pages to monitor", "type": "array", "description": "Public URLs to monitor. The Actor stores a snapshot for each URL and compares future runs against it.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "snapshotStoreName": { "title": "Snapshot store name", "type": "string", "description": "Named key-value store used to persist previous snapshots across runs. Use a different store per monitoring project.", "default": "website-change-monitor-snapshots" }, "maxItems": { "title": "Maximum pages per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety limit for how many URLs are processed in one run.", "default": 10 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of URLs processed in parallel. Keep low for browser mode to reduce memory and compute cost.", "default": 3 }, "extractionMode": { "title": "Extraction mode", "enum": [ "VISIBLE_TEXT", "HTML", "METADATA" ], "type": "string", "description": "Choose what should be compared. Visible text is best for most business monitoring. HTML is stricter. Metadata compares title, description, headings, and links.", "default": "VISIBLE_TEXT" }, "contentSelector": { "title": "Content CSS selector", "type": "string", "description": "Optional CSS selector to monitor only one part of the page, such as main, article, .pricing, or #content. Leave empty to monitor the body." }, "excludeSelectors": { "title": "Exclude CSS selectors", "type": "array", "description": "CSS selectors removed before comparison. Use this for navbars, footers, cookie banners, ads, timestamps, or dynamic widgets.", "default": [ "script", "style", "noscript", "svg", "iframe", "nav", "footer", "[aria-hidden=\"true\"]", ".cookie", ".cookies", "#cookie", "#cookies" ], "items": { "type": "string" } }, "ignoreRegexes": { "title": "Ignore regex patterns", "type": "array", "description": "Advanced: regex patterns removed from content before comparison. Useful for dates, counters, session IDs, ad slots, or personalization noise.", "default": [], "items": { "type": "string" } }, "ignoreWhitespace": { "title": "Ignore whitespace changes", "type": "boolean", "description": "Collapse repeated whitespace before comparison so formatting-only changes do not create noisy alerts.", "default": true }, "ignoreCase": { "title": "Ignore letter casing", "type": "boolean", "description": "Convert content to lowercase before comparison so capitalization-only changes are ignored.", "default": false }, "ignoreNumbers": { "title": "Ignore number changes", "type": "boolean", "description": "Replace numbers with a placeholder before comparison. Keep disabled when monitoring prices, quantities, metrics, or version numbers.", "default": false }, "ignoreDates": { "title": "Ignore date changes", "type": "boolean", "description": "Replace common date formats with a placeholder before comparison so last-updated timestamps do not create noisy alerts.", "default": true }, "significantChangeThreshold": { "title": "Significant change threshold", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum changed-content ratio required to mark a change as significant. 0.05 means roughly 5% of comparable text changed.", "default": 0.05 }, "emitMode": { "title": "Dataset output mode", "enum": [ "ALL", "CHANGES_ONLY", "SIGNIFICANT_ONLY" ], "type": "string", "description": "ALL writes a row for every monitored URL. CHANGES_ONLY writes first-seen and changed pages. SIGNIFICANT_ONLY writes only significant changes and errors.", "default": "ALL" }, "saveHtmlSnapshot": { "title": "Save HTML snapshots", "type": "boolean", "description": "Store raw HTML in the snapshot key-value store. Useful for evidence, but increases storage usage.", "default": false }, "updateSnapshots": { "title": "Update stored snapshots", "type": "boolean", "description": "Disable for dry runs. If disabled, the Actor compares against current stored snapshots without replacing them.", "default": true }, "maxDiffCharacters": { "title": "Maximum diff characters", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Maximum number of characters kept in addedText and removedText fields to keep dataset rows compact.", "default": 2000 }, "useBrowser": { "title": "Render pages with browser", "type": "boolean", "description": "Render pages with Playwright for JavaScript-heavy sites. Disabled by default to keep runs fast and cheap.", "default": false }, "maxRetries": { "title": "Maximum retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Number of retry attempts for transient network, timeout, 429, or 5xx errors.", "default": 2 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time in seconds to wait for each page request or browser navigation.", "default": 20 }, "maxContentBytes": { "title": "Max content bytes", "minimum": 50000, "maximum": 5000000, "type": "integer", "description": "Maximum response size read per URL. Default supports most modern pricing/docs pages while still stopping very large responses to protect memory and storage costs.", "default": 2000000 }, "allowPrivateUrls": { "title": "Allow private/internal URLs", "type": "boolean", "description": "Allow localhost, private IP ranges, and internal DNS targets. Keep disabled for public scraping to reduce SSRF risk.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration. Most public pages do not need 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 } } } } } } } } } }