{ "openapi": "3.0.1", "info": { "title": "Brand Monitoring — Mentions from News, HN, Bluesky & Reddit", "description": "Brand Monitoring: track every new mention of your brand, product, competitor or keyword across Google News, Hacker News, Bluesky, Reddit and Mastodon in one run, deduplicated, with date filters, exclude words, engagement and sentiment. Schedule it for alerts. No API key. Pay per mention.", "version": "1.0", "x-build-id": "YjnBnDOkFXt031Dc6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/intelscrape~brand-mentions-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-intelscrape-brand-mentions-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/intelscrape~brand-mentions-monitor/runs": { "post": { "operationId": "runs-sync-intelscrape-brand-mentions-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/intelscrape~brand-mentions-monitor/run-sync": { "post": { "operationId": "run-sync-intelscrape-brand-mentions-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": "Brands / keywords", "type": "array", "description": "Brand names, products, competitors or topics. Multi-word terms are searched as exact phrases.", "items": { "type": "string" } }, "sources": { "title": "Sources", "type": "array", "description": "Where to look.", "items": { "type": "string", "enum": [ "googleNews", "hackerNews", "bluesky", "reddit", "mastodon" ], "enumTitles": [ "Google News", "Hacker News", "Bluesky", "Reddit", "Mastodon (hashtag)" ] }, "default": [ "googleNews", "hackerNews", "bluesky", "reddit" ] }, "sinceDays": { "title": "Only mentions from the last N days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Time window.", "default": 7 }, "maxPerSource": { "title": "Max mentions per source per keyword", "minimum": 1, "maximum": 500, "type": "integer", "description": "Caps cost on very popular keywords.", "default": 50 }, "excludeWords": { "title": "Exclude words", "type": "array", "description": "Drop mentions containing any of these words (e.g. a homonym).", "default": [], "items": { "type": "string" } }, "sentiment": { "title": "Sentiment tagging (recommended)", "type": "boolean", "description": "Tag each mention positive, negative or neutral. Charged per mention.", "default": true }, "language": { "title": "Language", "type": "string", "description": "Language code for Google News and Bluesky.", "default": "en" }, "country": { "title": "Country (Google News)", "type": "string", "description": "Google News edition, e.g. US, GB, IN, AU.", "default": "US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed normally. The actor switches to Apify Proxy automatically if the source starts rate-limiting.", "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 }, "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 } } } } } } } } } }