{ "openapi": "3.0.1", "info": { "title": "News & Competitor Monitoring Bundle", "description": "Monitor competitors, brand monitoring signals, topics, RSS feeds, and market news, then save prioritized AI-ready records for alerts and analysis.", "version": "0.1", "x-build-id": "hUUIK6l9h37OVaNke" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/runtime~news-competitor-monitoring-bundle/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-runtime-news-competitor-monitoring-bundle", "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/runtime~news-competitor-monitoring-bundle/runs": { "post": { "operationId": "runs-sync-runtime-news-competitor-monitoring-bundle", "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/runtime~news-competitor-monitoring-bundle/run-sync": { "post": { "operationId": "run-sync-runtime-news-competitor-monitoring-bundle", "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", "properties": { "workflow": { "title": "Workflow", "enum": [ "competitor-monitor", "brand-news-watch", "local-news-monitor", "custom" ], "type": "string", "description": "Business workflow label stored on each output item.", "default": "competitor-monitor" }, "topic": { "title": "Topic", "type": "string", "description": "Single topic to monitor. Used when Topics is empty.", "default": "AI startup funding" }, "topics": { "title": "Topics", "type": "array", "description": "Topics to monitor, one per line.", "items": { "type": "string" }, "default": [] }, "brand": { "title": "Brand", "type": "string", "description": "Single brand to monitor. Used when Brands is empty.", "default": "" }, "brands": { "title": "Brands", "type": "array", "description": "Brands to monitor, one per line.", "items": { "type": "string" }, "default": [] }, "competitor": { "title": "Competitor", "type": "string", "description": "Single competitor to monitor. Used when Competitors is empty.", "default": "" }, "competitors": { "title": "Competitors", "type": "array", "description": "Competitors to monitor, one per line.", "items": { "type": "string" }, "default": [] }, "includeManualItems": { "title": "Include manual items", "type": "boolean", "description": "Normalize manually provided news or competitor-monitoring records.", "default": true }, "manualItems": { "title": "Manual items", "type": "array", "description": "Optional articles, announcements, or competitor updates to normalize.", "items": { "type": "object", "properties": { "provider": { "title": "Provider", "description": "Source provider, publication, or site.", "type": "string" }, "title": { "title": "Title", "description": "Article or update title.", "type": "string" }, "url": { "title": "URL", "description": "Article or update URL.", "type": "string" }, "summary": { "title": "Summary", "description": "Short summary or source snippet.", "type": "string" }, "publishedAt": { "title": "Published at", "description": "Published timestamp or date.", "type": "string" } } }, "default": [] }, "includeWebDiscovery": { "title": "Collect web signals", "type": "boolean", "description": "Collect supporting news and competitor signals using direct web search.", "default": true }, "searchQueries": { "title": "Custom search queries", "type": "array", "description": "Optional custom search queries, one per line. If empty, the Actor generates topic/brand/competitor queries.", "items": { "type": "string" }, "default": [] }, "searchMode": { "title": "Search mode", "enum": [ "news", "default" ], "type": "string", "description": "DuckDuckGo vertical to query.", "default": "news" }, "searchProviders": { "title": "Search providers", "type": "array", "description": "Search providers to use. Brave requires BRAVE_SEARCH_API_KEY or braveApiKey.", "items": { "type": "string", "enum": [ "duckduckgo", "brave" ], "enumTitles": [ "DuckDuckGo", "Brave Search API" ] }, "default": [ "duckduckgo" ] }, "braveApiKey": { "title": "Brave API key", "type": "string", "description": "Optional Brave Search API key. Prefer using the BRAVE_SEARCH_API_KEY environment variable." }, "includeRssFeeds": { "title": "Include RSS feeds", "type": "boolean", "description": "Fetch and normalize RSS/Atom feeds listed in RSS feed URLs.", "default": false }, "rssFeedUrls": { "title": "RSS feed URLs", "type": "string", "description": "RSS or Atom feed URLs, one per line.", "default": "" }, "keywords": { "title": "Extra match keywords", "type": "array", "description": "Extra relevance keywords, one per line.", "items": { "type": "string" }, "default": [] }, "maxResults": { "title": "Max output records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum normalized records saved by the bundle.", "default": 25 }, "maxWebQueries": { "title": "Max web queries", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum generated/custom web queries to execute.", "default": 6 }, "maxWebResults": { "title": "Max web results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum web-discovery results to normalize.", "default": 20 }, "maxRssItems": { "title": "Max RSS items", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum RSS items to normalize.", "default": 20 }, "mockMode": { "title": "Mock mode", "type": "boolean", "description": "Generate sample news monitoring records without network access.", "default": false }, "failOnNoResults": { "title": "Fail on no results", "type": "boolean", "description": "Fail the run if no normalized records are produced.", "default": true }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for web search and RSS requests.", "default": 20 }, "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Enable Apify Proxy for direct web discovery.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Advanced Apify Proxy or custom proxy settings.", "default": {} } } }, "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 } } } } } } } } } }