{ "openapi": "3.0.1", "info": { "title": "Competitor Website Change Tracker1", "description": "Monitor competitor websites and get instant alerts when anything changes — content, pricing, or UI. Combines text diffing with pixel-level visual comparison to give you a complete picture of what changed.", "version": "0.0", "x-build-id": "OGzlvLFcJ0ZROdMfF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/erinle_sam~competitor-website-change-tracker1/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-erinle_sam-competitor-website-change-tracker1", "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/erinle_sam~competitor-website-change-tracker1/runs": { "post": { "operationId": "runs-sync-erinle_sam-competitor-website-change-tracker1", "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/erinle_sam~competitor-website-change-tracker1/run-sync": { "post": { "operationId": "run-sync-erinle_sam-competitor-website-change-tracker1", "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": "Start URLs", "type": "array", "description": "List of URLs to capture screenshots and/or PDFs from.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "captureMode": { "title": "Capture Mode", "enum": [ "screenshot", "pdf", "both" ], "type": "string", "description": "What to capture from each page.", "default": "both" }, "fullPage": { "title": "Full Page Capture", "type": "boolean", "description": "Capture the entire scrollable page instead of just the viewport.", "default": true }, "autoScroll": { "title": "Auto Scroll", "type": "boolean", "description": "Automatically scroll the page to load lazy elements before capturing.", "default": true }, "viewportWidth": { "title": "Viewport Width", "minimum": 320, "maximum": 3840, "type": "integer", "description": "Browser viewport width in pixels.", "default": 1920 }, "viewportHeight": { "title": "Viewport Height", "minimum": 240, "maximum": 2160, "type": "integer", "description": "Browser viewport height in pixels.", "default": 1080 }, "crawlDepth": { "title": "Crawl Depth", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many levels deep to crawl from start URLs (0 = only start URLs, 1 = start URLs + their links, etc.).", "default": 0 }, "maxPagesPerDomain": { "title": "Max Pages Per Domain", "minimum": 0, "type": "integer", "description": "Maximum number of pages to capture per domain (0 = unlimited).", "default": 50 }, "waitForSelector": { "title": "Wait for Selector", "type": "string", "description": "CSS selector to wait for before capturing (useful for dynamic content). Leave empty to skip." }, "waitForNetworkIdle": { "title": "Wait for Network Idle", "type": "boolean", "description": "Wait for network to be idle before capturing (recommended for SPAs and complex webapps).", "default": true }, "waitTime": { "title": "Additional Wait Time (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Additional time to wait in milliseconds before capturing (after other wait conditions).", "default": 1000 }, "removeElements": { "title": "Remove Elements", "type": "array", "description": "CSS selectors of elements to hide before capturing (e.g., cookie banners, chat widgets).", "default": [], "items": { "type": "string" } }, "screenshotFormat": { "title": "Screenshot Format", "enum": [ "png", "jpeg" ], "type": "string", "description": "Image format for screenshots.", "default": "png" }, "screenshotQuality": { "title": "Screenshot Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "JPEG quality (1-100, only applies to JPEG format).", "default": 90 }, "pdfFormat": { "title": "PDF Format", "enum": [ "Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6" ], "type": "string", "description": "Paper format for PDF generation.", "default": "A4" }, "pdfPrintBackground": { "title": "PDF Print Background", "type": "boolean", "description": "Include background graphics in PDF.", "default": true }, "cookies": { "title": "Cookies", "type": "array", "description": "Cookies to set before navigating to pages (for authentication, etc.).", "default": [] }, "headers": { "title": "Custom Headers", "type": "object", "description": "Custom HTTP headers to send with requests.", "default": {} }, "maxRequestsPerCrawl": { "title": "Max Requests Per Crawl", "minimum": 1, "type": "integer", "description": "Maximum total number of pages to process across all domains.", "default": 100 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for bypassing restrictions.", "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 } } } } } } } } } }