{ "openapi": "3.0.1", "info": { "title": "Reddit & Forum Sentiment Analyzer", "description": "Mine authentic brand/product/competitor sentiment from Reddit and Hacker News at scale. Per-post sentiment, theme clustering, competitor mention tracking, trend detection. Pay per post analyzed.", "version": "0.1", "x-build-id": "Mu1q9mRcZjJNZaLEK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ramsford~reddit-forum-sentiment-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ramsford-reddit-forum-sentiment-analyzer", "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/ramsford~reddit-forum-sentiment-analyzer/runs": { "post": { "operationId": "runs-sync-ramsford-reddit-forum-sentiment-analyzer", "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/ramsford~reddit-forum-sentiment-analyzer/run-sync": { "post": { "operationId": "run-sync-ramsford-reddit-forum-sentiment-analyzer", "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": "Search keywords", "type": "array", "description": "Brand names, product names, or topics to mine sentiment for. Each is searched independently. Example: ['Notion', 'Obsidian'].", "items": { "type": "string" } }, "subreddits": { "title": "Subreddits (optional)", "type": "array", "description": "Limit Reddit search to these subreddits (without 'r/' prefix). Leave empty to search all of Reddit. Example: ['productivity', 'startups'].", "items": { "type": "string" } }, "sources": { "title": "Sources to mine", "uniqueItems": true, "type": "array", "description": "Which platforms to pull from.", "items": { "type": "string", "enum": [ "reddit", "hackernews" ], "enumTitles": [ "Reddit", "Hacker News" ] }, "default": [ "reddit", "hackernews" ] }, "maxPosts": { "title": "Max posts per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Cap the number of posts analyzed per keyword. Each post counts as one billable record.", "default": 50 }, "maxCommentsPerPost": { "title": "Max top comments per post", "minimum": 0, "maximum": 50, "type": "integer", "description": "How many top comments per post to fetch and include in sentiment analysis. 0 disables comment fetching (saves time).", "default": 10 }, "dateRange": { "title": "Date range", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "Restrict posts to this time window (Reddit search 't' parameter, mapped for HN too).", "default": "month" }, "sortBy": { "title": "Sort order (Reddit)", "enum": [ "relevance", "new", "top", "hot", "comments" ], "type": "string", "description": "Reddit search sort. 'relevance' is best for brand monitoring; 'new' is best for trend alerts; 'top' is best for impact.", "default": "relevance" }, "competitors": { "title": "Competitor terms (optional)", "type": "array", "description": "Track mentions of these competitor names across the same posts. Comparative sentiment is computed when a post mentions both the keyword and a competitor.", "items": { "type": "string" } }, "minScore": { "title": "Min score (Reddit upvotes / HN points)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Skip posts below this score threshold. 0 disables.", "default": 0 }, "includeRawText": { "title": "Include full post body & comments in output", "type": "boolean", "description": "Off by default for compact JSON. Turn on if you need the raw text for downstream NLP.", "default": false }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy. Reddit JSON endpoints are generally fine without residential proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } } } }, "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 } } } } } } } } } }