{ "openapi": "3.0.1", "info": { "title": "Hacker News Keyword Mention Monitor", "description": "Monitor Hacker News stories and comments for brand, competitor, product, and technology mentions.", "version": "0.1", "x-build-id": "ATZVyAr5OwQDrOFOS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/enviable_shell~hn-keyword-mention-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-enviable_shell-hn-keyword-mention-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/enviable_shell~hn-keyword-mention-monitor/runs": { "post": { "operationId": "runs-sync-enviable_shell-hn-keyword-mention-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/enviable_shell~hn-keyword-mention-monitor/run-sync": { "post": { "operationId": "run-sync-enviable_shell-hn-keyword-mention-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", "type": "array", "description": "Brands, competitors, products, domains, or technology terms to monitor.", "default": [ "OpenAI", "Claude", "Cursor", "Codex" ], "items": { "type": "string" } }, "maxItemsPerKeyword": { "title": "Maximum items per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum matching stories/comments to return for each keyword.", "default": 50 }, "searchIn": { "title": "Search in", "enum": [ "all", "stories", "comments" ], "type": "string", "description": "Search stories, comments, or both.", "default": "all" }, "matchMode": { "title": "Match mode", "enum": [ "strict", "broad" ], "type": "string", "description": "Strict keeps only records where the keyword appears in the title, text, or URL. Broad keeps all Algolia search results for maximum recall.", "default": "strict" }, "createdAfter": { "title": "Created after", "type": "string", "description": "Optional ISO date, for example 2026-01-01. Only mentions created after this date are returned." }, "minPoints": { "title": "Minimum story points", "minimum": 0, "type": "integer", "description": "Only include stories with at least this many points. Comments without story points are kept unless this is used with stories-only filtering.", "default": 0 }, "includeText": { "title": "Include full text", "type": "boolean", "description": "Include cleaned story/comment text in output. Snippets are always included.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional Slack, Discord, Zapier, Make, n8n, or custom webhook URL. The Actor POSTs a JSON payload with the run summary and top mentions." }, "failOnWebhookError": { "title": "Fail on webhook error", "type": "boolean", "description": "If enabled, the run fails when the webhook returns an error or cannot be reached. Keep disabled for scheduled monitoring.", "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 } } } } } } } } } }