{ "openapi": "3.0.1", "info": { "title": "Competitor Website Change Monitor & Briefing", "description": "Monitor competitor websites, detect meaningful changes across runs, and turn them into decision-ready competitive intelligence and briefings.", "version": "0.1", "x-build-id": "nJTnJSP3usGar4rG1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solutionssmart~competitor-website-change-briefing/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solutionssmart-competitor-website-change-briefing", "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/solutionssmart~competitor-website-change-briefing/runs": { "post": { "operationId": "runs-sync-solutionssmart-competitor-website-change-briefing", "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/solutionssmart~competitor-website-change-briefing/run-sync": { "post": { "operationId": "run-sync-solutionssmart-competitor-website-change-briefing", "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": { "monitorId": { "title": "Monitor ID", "type": "string", "description": "Optional stable identifier for persistent run-to-run memory. Use this when the same monitor should keep history across scheduled runs." }, "startUrls": { "title": "Start URLs", "minItems": 1, "type": "array", "description": "Homepage or section URLs to seed monitoring from. One site can have multiple seed URLs.", "items": { "type": "string" } }, "allowedDomains": { "title": "Allowed domains", "type": "array", "description": "Domains that are allowed for crawl discovery. Defaults to domains derived from start URLs.", "items": { "type": "string" } }, "includeUrlPatterns": { "title": "Include URL patterns", "type": "array", "description": "Optional glob-style patterns or regex-prefixed rules such as regex:/pricing|security/i.", "items": { "type": "string" } }, "excludeUrlPatterns": { "title": "Exclude URL patterns", "type": "array", "description": "Glob-style patterns that should be ignored during crawl and change detection.", "items": { "type": "string" } }, "maxPagesPerSite": { "title": "Max pages per site", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of pages to crawl per monitored site.", "default": 40 }, "crawlMode": { "title": "Crawl mode", "enum": [ "focused", "sitewide" ], "type": "string", "description": "Focused prioritizes key commercial sections. Sitewide follows all in-scope links until the page cap is reached.", "default": "focused" }, "prioritySections": { "title": "Priority sections", "uniqueItems": true, "type": "array", "description": "Sections to prioritize first during focused crawls.", "items": { "type": "string", "enum": [ "homepage", "pricing", "product", "blog", "careers", "case-studies", "security", "docs" ] }, "default": [ "homepage", "pricing", "product", "blog", "careers", "case-studies", "security" ] }, "watchKeywords": { "title": "Watch keywords", "type": "array", "description": "Business terms that should be highlighted when they appear or disappear.", "items": { "type": "string" } }, "outputLanguage": { "title": "Output language", "type": "string", "description": "Language code for generated briefings.", "default": "en" }, "changeThreshold": { "title": "Change threshold", "enum": [ "low", "medium", "high" ], "type": "string", "description": "Minimum severity that will be included in the output briefing.", "default": "medium" }, "summarizationMode": { "title": "Summarization mode", "enum": [ "deterministic", "llm" ], "type": "string", "description": "Deterministic mode is fully functional. LLM mode only enhances deterministic outputs in v1.", "default": "deterministic" }, "enableBriefing": { "title": "Enable briefing output", "type": "boolean", "description": "Generate Markdown and JSON briefing artifacts.", "default": true }, "enableHtmlDashboard": { "title": "Enable HTML dashboard", "type": "boolean", "description": "Generate a compact self-contained HTML dashboard.", "default": false }, "callbackUrl": { "title": "Callback URL", "type": "string", "description": "Optional webhook URL that receives the JSON briefing after a successful run." }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Upper bound for concurrent browser pages. This Actor uses a conservative maximum of 4 browser pages to keep monitoring runs stable and cost-efficient.", "default": 4 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-page processing timeout.", "default": 30 }, "saveRawSnapshots": { "title": "Save raw HTML snapshots", "type": "boolean", "description": "Store raw HTML in per-page snapshots for debugging and offline review.", "default": false }, "includeDocsSignals": { "title": "Include docs signals", "type": "boolean", "description": "Include docs/help/reference signals in public output. Disabled by default to reduce noise.", "default": false }, "includeDebugFields": { "title": "Include debug fields", "type": "boolean", "description": "Expose internal classification and aggregation hints in public dataset items for debugging.", "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 } } } } } } } } } }