{ "openapi": "3.0.1", "info": { "title": "Reddit Keyword Monitor: Brand Mentions & Alerts", "description": "Watch Reddit for your brand, product or any keyword: each run returns only new posts that mention it, with the matched keyword, a text snippet, score, comments count and link. Schedule it for daily alerts.", "version": "0.1", "x-build-id": "zE2H6AZTtCWLRn76e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/himanshu-data~reddit-keyword-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-himanshu-data-reddit-keyword-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/himanshu-data~reddit-keyword-monitor/runs": { "post": { "operationId": "runs-sync-himanshu-data-reddit-keyword-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/himanshu-data~reddit-keyword-monitor/run-sync": { "post": { "operationId": "run-sync-himanshu-data-reddit-keyword-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", "properties": { "keywords": { "title": "Keywords to watch", "type": "array", "description": "Your brand, product, competitors or any phrase. One per line.", "items": { "type": "string" } }, "subreddits": { "title": "Only in these subreddits (optional)", "type": "array", "description": "Leave empty to watch all of Reddit.", "items": { "type": "string" } }, "excludeWords": { "title": "Exclude posts with these words (optional)", "type": "array", "description": "For example jobs, hiring, or a namesake you are not interested in.", "items": { "type": "string" } }, "exactPhrase": { "title": "Match multi-word keywords as an exact phrase", "type": "boolean", "description": "\"electric scooter\" instead of posts that mention electric and scooter separately.", "default": true }, "maxPostsPerSource": { "title": "Max new posts per keyword", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Per keyword (and per subreddit, if you listed any).", "default": 50 }, "includeFullText": { "title": "Include full post text", "type": "boolean", "description": "Opens each new post for its full text and a snippet around the keyword. Off is faster and returns titles only.", "default": true }, "strictMatch": { "title": "Only exact mentions", "type": "boolean", "description": "Reddit search also returns loosely related posts. On keeps only posts whose title or text really contains the keyword (others are skipped and not charged). Works best with full text on.", "default": true }, "timeFilter": { "title": "Look back", "enum": [ "hour", "day", "week", "month", "year", "all" ], "type": "string", "description": "How far back the first run looks. Later runs return only posts not returned before.", "default": "week" }, "onlyNew": { "title": "Only posts not returned before", "type": "boolean", "description": "Remembers posts from earlier runs and returns only posts it has not returned before. Schedule it daily for brand, competitor or keyword alerts.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Runs with the same name share one memory of posts already returned. Use different names for separate monitors.", "default": "reddit-keyword-monitor" }, "postedAfter": { "title": "Only posts after (optional)", "type": "string", "description": "Skip posts older than this date, e.g. 2026-10-01." }, "includeNsfw": { "title": "Include NSFW posts", "type": "boolean", "description": "Off skips posts Reddit marks as NSFW.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Reddit blocks data-center IPs, so residential proxies are used by default.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }