{ "openapi": "3.0.1", "info": { "title": "Website Change Intelligence Monitor", "description": "Monitor public web pages and detect meaningful text, title, metadata, and link changes between runs.", "version": "0.2", "x-build-id": "dMeEUow2qUx0Lcu1c" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/woolly_kingcrab~website-change-intelligence-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-woolly_kingcrab-website-change-intelligence-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/woolly_kingcrab~website-change-intelligence-monitor/runs": { "post": { "operationId": "runs-sync-woolly_kingcrab-website-change-intelligence-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/woolly_kingcrab~website-change-intelligence-monitor/run-sync": { "post": { "operationId": "run-sync-woolly_kingcrab-website-change-intelligence-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": "Page URLs", "type": "array", "description": "Up to 50 public http/https page URLs.", "items": { "type": "string" } }, "monitorId": { "title": "Monitor ID", "type": "string", "description": "Stable name for this monitoring configuration. Reuse the SAME value on every scheduled run so pages are compared against their previous baseline.", "default": "default" }, "outputMode": { "title": "Output mode", "enum": [ "CHANGES_ONLY", "ALL_CHECKS" ], "type": "string", "description": "CHANGES_ONLY returns changed pages plus per-page summaries. ALL_CHECKS also returns a row for pages that did not change.", "default": "CHANGES_ONLY" }, "includeTextDiff": { "title": "Include added / removed text", "type": "boolean", "description": "Emit ADDED_TEXT and REMOVED_TEXT rows with the changed sentences. Turn off for a lighter feed.", "default": true }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional. Only report a page's changes when the added/removed text or new title contains one of these (case-insensitive).", "items": { "type": "string" }, "default": [] }, "contentSelector": { "title": "Content CSS selector", "type": "string", "description": "Optional. Monitor only a section of the page, e.g. main or #pricing.", "default": "" }, "ignoreSelectors": { "title": "Ignore CSS selectors", "type": "array", "description": "Optional elements to remove before comparison, e.g. .cookie-banner or .timestamp. script/style/svg are always ignored.", "items": { "type": "string" }, "default": [] }, "trackLinks": { "title": "Track links", "type": "boolean", "description": "Detect added and removed links (tracking parameters are stripped first).", "default": true }, "majorChangeThresholdPct": { "title": "Major change threshold (%)", "minimum": 1, "maximum": 100, "type": "number", "description": "Text-change percentage at or above which a change is classified as MAJOR in the summary.", "default": 20 }, "maxTextCharacters": { "title": "Maximum text characters", "minimum": 1000, "maximum": 500000, "type": "integer", "description": "Safety cap for the normalized page text used in comparison.", "default": 200000 }, "maxContentBytes": { "title": "Maximum download bytes", "minimum": 100000, "maximum": 20000000, "type": "integer", "description": "Abort a page fetch that exceeds this size.", "default": 5000000 }, "requestTimeout": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-page fetch timeout.", "default": 20 }, "emitBaseline": { "title": "Emit baseline (deprecated)", "type": "boolean", "description": "Deprecated compatibility field. v0.2 uses outputMode. This value is accepted for older tasks but does not control v0.2 output.", "default": 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 } } } } } } } } } }