{ "openapi": "3.0.1", "info": { "title": "Structured API & Web Change Feed", "description": "Detect typed JSON, XML, HTML, and text changes with paths, before/after values, type changes, numeric deltas, and automation-ready events.", "version": "0.1", "x-build-id": "GtHfPUkR4votqj2ZZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api_web_change_monitor~structured-api-web-change-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api_web_change_monitor-structured-api-web-change-feed", "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/api_web_change_monitor~structured-api-web-change-feed/runs": { "post": { "operationId": "runs-sync-api_web_change_monitor-structured-api-web-change-feed", "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/api_web_change_monitor~structured-api-web-change-feed/run-sync": { "post": { "operationId": "run-sync-api_web_change_monitor-structured-api-web-change-feed", "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": { "monitorId": { "title": "Monitor ID", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "type": "string", "description": "Stable identifier for a group of baselines across Actor runs.", "default": "default" }, "targets": { "title": "Targets", "minItems": 1, "maxItems": 100, "type": "array", "description": "Public HTTP targets to check. Maximum 100 targets per run.", "items": { "type": "object", "properties": { "id": { "type": "string", "title": "Target ID", "description": "Optional stable identifier for this target.", "editor": "textfield" }, "url": { "type": "string", "title": "URL", "description": "Public HTTP or HTTPS URL. Private and local addresses are blocked.", "editor": "textfield" }, "type": { "type": "string", "title": "Content type", "description": "AUTO checks Content-Type first, then detects the body format.", "default": "AUTO", "editor": "select", "enum": [ "AUTO", "JSON", "XML", "HTML", "TEXT" ], "enumTitles": [ "Auto detect", "JSON", "XML", "HTML", "Text" ] }, "cssSelector": { "type": "string", "title": "CSS selector", "description": "Limit HTML monitoring to matching elements.", "editor": "textfield" }, "ignoreSelectors": { "type": "array", "title": "Ignored CSS selectors", "description": "Remove matching HTML elements before comparison.", "editor": "json", "items": { "type": "string" } }, "jsonPointer": { "type": "string", "title": "JSON Pointer", "description": "Monitor only the selected JSON subtree.", "editor": "textfield" }, "ignoreJsonPointers": { "type": "array", "title": "Ignored JSON Pointers", "description": "Exact JSON Pointers relative to the selected root.", "editor": "json", "items": { "type": "string" } }, "arrayIdentityKeys": { "type": "object", "title": "JSON array identity keys", "description": "Map each array path to a direct identity field, for example /products -> id.", "editor": "json", "maxProperties": 10, "additionalProperties": true }, "xpath": { "type": "string", "title": "XPath", "description": "Limit XML monitoring to matching nodes.", "editor": "textfield" } }, "required": [ "url" ], "additionalProperties": false } }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of targets processed at the same time.", "default": 5 }, "timeoutSecs": { "title": "Request timeout", "minimum": 1, "maximum": 30, "type": "integer", "description": "Timeout for each HTTP request, in seconds.", "default": 15 }, "maxResponseBytes": { "title": "Maximum response bytes", "minimum": 1, "maximum": 2097152, "type": "integer", "description": "Hard limit for the decompressed response body.", "default": 1048576 }, "resetBaseline": { "title": "Reset baseline", "type": "boolean", "description": "Replace the baseline after a successful fetch without emitting a diff.", "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 } } } } } } } } } }