{
"openapi": "3.0.1",
"info": {
"title": "Brand Mention Monitor",
"description": "Brand monitoring and social listening tool. Track your brand, competitors, or keywords on Reddit, X (Twitter), Hacker News, Bluesky, Instagram, LinkedIn, GitHub, and 4 more. Get only new mentions in one feed, with Slack or email alerts.",
"version": "0.0",
"x-build-id": "GCjMt9owgGbwwuLrQ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/patrikbraborec~brand-mention-monitor/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-patrikbraborec-brand-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/patrikbraborec~brand-mention-monitor/runs": {
"post": {
"operationId": "runs-sync-patrikbraborec-brand-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/patrikbraborec~brand-mention-monitor/run-sync": {
"post": {
"operationId": "run-sync-patrikbraborec-brand-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": "What to monitor",
"minItems": 1,
"maxItems": 10,
"type": "array",
"description": "Brand, product, person or topic. Add spelling variants or aliases on separate lines (e.g. Apify, apify.com). Each line is matched as an exact phrase, case-insensitive.",
"items": {
"type": "string"
}
},
"platforms": {
"title": "Where to look",
"type": "array",
"description": "Platforms to search. Hacker News is free. Every other platform is fetched by a partner Actor from Apify Store that bills you separately on your Apify account: a small start fee per run plus a fee per result, capped at $1 per run in total. With the defaults that's about $0.02 per run in start fees plus up to ~$0.25 per run in results. See the README for prices. To use only the free source, keep just Hacker News.",
"items": {
"type": "string",
"enum": [
"reddit",
"hackernews",
"bluesky",
"googlenews",
"github",
"x",
"instagram",
"linkedin",
"facebook",
"threads",
"tiktok"
],
"enumTitles": [
"Reddit",
"Hacker News",
"Bluesky",
"Google News",
"GitHub issues & PRs",
"X / Twitter",
"Instagram",
"LinkedIn",
"Facebook",
"Threads",
"TikTok"
]
},
"default": [
"reddit",
"hackernews",
"bluesky",
"googlenews",
"github",
"x"
]
},
"lookbackDays": {
"title": "First run looks back (days)",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "How far back the first run searches. Later runs only return mentions that are new since the previous run.",
"default": 7
},
"excludeKeywords": {
"title": "Exclude mentions containing",
"type": "array",
"description": "Drops any mention whose text contains one of these words. For \"Apple\", for example: fruit, pie, recipe.",
"default": [],
"items": {
"type": "string"
}
},
"aboutBrand": {
"title": "AI relevance filter: what is it?",
"maxLength": 300,
"type": "string",
"description": "Describe what you're tracking in a few words, e.g. \"Notion, the note-taking app\". When this is filled in, an AI model reads each new mention and drops the unrelated ones ($0.002 per checked mention). The model runs through the OpenRouter Actor, which bills its token usage to your Apify account separately (well under $0.001 per mention). Leave it empty to skip the filter."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}