{ "openapi": "3.0.1", "info": { "title": "Discourse Forum Monitor — New Topics & Replies", "description": "Monitor any Discourse community for brand mentions, new topics, replies and trending threads. Get only what changed since your last run, not the whole forum.", "version": "0.1", "x-build-id": "gMxM8ZYjBib4BKWZA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dev_web_col~discourse-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dev_web_col-discourse-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/dev_web_col~discourse-monitor/runs": { "post": { "operationId": "runs-sync-dev_web_col-discourse-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/dev_web_col~discourse-monitor/run-sync": { "post": { "operationId": "run-sync-dev_web_col-discourse-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": [ "forumUrls" ], "properties": { "oneShot": { "title": "One-shot mode (no history)", "type": "boolean", "description": "Return the CURRENT topics instead of what changed. Use this for a single lookup or from an AI agent — the monitor needs two runs before it has anything to compare. It never touches your saved history.", "default": false }, "forumUrls": { "title": "Discourse forums to watch", "type": "array", "description": "Just the domain: community.openai.com, meta.discourse.org, forum.rclone.org. Almost every developer tool and SaaS community runs Discourse. This actor watches the forums you choose; it does not discover them.", "items": { "type": "string" } }, "keywords": { "title": "Keywords to watch (brand monitoring)", "type": "array", "description": "Watch only topics mentioning these words — your product, a competitor, a feature. Leave empty to watch the forum's recent topics instead.", "items": { "type": "string" } }, "monitorKey": { "title": "Monitor name", "type": "string", "description": "Keep this the same across runs — it is how the actor remembers what it already saw. Use a different name for an independent watchlist.", "default": "default" }, "trackSignals": { "title": "What to report", "type": "array", "description": "Leave empty to get everything. New topic and new replies are what you usually want for brand monitoring.", "items": { "type": "string", "enum": [ "new_topic", "new_replies", "answered", "trending", "closed", "removed" ], "enumTitles": [ "New topic", "New replies", "Answer accepted", "Trending (views spiking)", "Topic closed", "Topic removed" ] }, "default": [] }, "maxPages": { "title": "Pages of recent topics", "minimum": 1, "maximum": 20, "type": "integer", "description": "Only when not using keywords. Each page is 30 topics. Keep it stable across runs.", "default": 3 }, "minViews": { "title": "Minimum views", "minimum": 0, "type": "integer", "description": "Ignore topics below this view count. Views are only available when watching recent topics, not keyword search." }, "categoryIds": { "title": "Category IDs", "type": "array", "description": "Only watch these forum categories. Find the ID in the category URL. Leave empty for all.", "default": [] }, "tags": { "title": "Tags", "type": "array", "description": "Only watch topics carrying at least one of these tags. Leave empty for all.", "default": [], "items": { "type": "string" } }, "maxChanges": { "title": "Max changes to return", "minimum": 1, "type": "integer", "description": "Safety cap. You are charged per change returned.", "default": 5000 }, "resetBaseline": { "title": "Reset and start over", "type": "boolean", "description": "Forget everything seen before and take a fresh baseline. The baseline run is never charged per result.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Discourse forums are usually reachable without a proxy, but a busy schedule across many forums may need one.", "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 } } } } } } } } } }