{ "openapi": "3.0.1", "info": { "title": "Tech Community Monitor — HN Brand & Keyword Tracker", "description": "Track brand, product & keyword mentions on Hacker News in real time. Social listening & brand monitoring via the open HN API — no scraping, no blocking. Monitor mode returns only NEW mentions for alerts.", "version": "1.0", "x-build-id": "aCrWNNXEbwcY9fUIE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vertaizen~tech-community-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vertaizen-tech-community-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/vertaizen~tech-community-monitor/runs": { "post": { "operationId": "runs-sync-vertaizen-tech-community-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/vertaizen~tech-community-monitor/run-sync": { "post": { "operationId": "run-sync-vertaizen-tech-community-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": [ "keywords" ], "properties": { "keywords": { "title": "Keywords / brands to track", "type": "array", "description": "Brands, products, competitors or keywords to search for across tech communities (case-insensitive). Examples: `apify`, `your-startup`, `postgres`.", "items": { "type": "string" } }, "sources": { "title": "Sources", "type": "array", "description": "Which communities to search. Currently supports the Hacker News open Algolia API — the fast, reliable, unblocked core. More sources can be added over time.", "items": { "type": "string", "enum": [ "hackernews" ], "enumTitles": [ "Hacker News" ] }, "default": [ "hackernews" ] }, "searchStories": { "title": "Search stories", "type": "boolean", "description": "Include Hacker News stories (posts, Show HN, Ask HN, submitted links).", "default": true }, "searchComments": { "title": "Search comments", "type": "boolean", "description": "Include Hacker News comments that mention your keyword. Great for catching organic discussion and buying signals inside threads.", "default": false }, "timeRangeDays": { "title": "Time range (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only return mentions created within the last N days.", "default": 7 }, "maxResultsPerKeyword": { "title": "Max results per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safety cap on the number of mentions returned per keyword.", "default": 100 }, "monitorMode": { "title": "Monitor mode — only NEW mentions", "type": "boolean", "description": "When enabled, the actor remembers previously seen mentions per keyword and only outputs mentions that appeared since the last run. Ideal for scheduled runs with webhook alerting (Slack, email, CRM).", "default": false }, "minPoints": { "title": "Minimum points", "minimum": 0, "type": "integer", "description": "Filter out low-signal stories below this HN points threshold. Comments have no points and are treated as 0 (only included when this is 0).", "default": 0 }, "exactMatch": { "title": "Exact keyword match", "type": "boolean", "description": "HN search is typo-tolerant (e.g. \"shopify\" can return \"spotify\"). When on, only items where the keyword appears as a whole word in the title/text are returned — avoids false positives for brand monitoring. Turn off for broader/fuzzy discovery.", "default": true } } }, "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 } } } } } } } } } }