{ "openapi": "3.0.1", "info": { "title": "Brand Mention Monitor", "description": "Track every news mention of your brand, your competitors or any topic. Returns the headline, publisher, link and date, and on scheduled runs gives you only the mentions that are new.", "version": "0.1", "x-build-id": "UjV58WHXnMVS0vZPR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/arched_friend~brand-mention-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-arched_friend-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/arched_friend~brand-mention-monitor/runs": { "post": { "operationId": "runs-sync-arched_friend-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/arched_friend~brand-mention-monitor/run-sync": { "post": { "operationId": "run-sync-arched_friend-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": [ "queries" ], "properties": { "queries": { "title": "What to watch", "type": "array", "description": "Brand names, competitor names, people or topics, one per line. Each is searched separately so you can tell the results apart.", "items": { "type": "string" } }, "matchExactPhrase": { "title": "Match the exact phrase", "type": "boolean", "description": "Wrap each term in quotes so a two word brand is matched as one phrase. Turn off to search the words loosely.", "default": true }, "freshnessDays": { "title": "Only the last N days", "minimum": 0, "maximum": 365, "type": "integer", "description": "Limit results to the last few days. 0 returns whatever the feed holds. Set to 1 or 7 for daily or weekly monitoring.", "default": 0 }, "maxItemsPerQuery": { "title": "Mentions per term", "minimum": 1, "type": "integer", "description": "Upper limit on how many mentions to return for each term.", "default": 100 }, "onlyNewMentions": { "title": "Only mentions I have not seen", "type": "boolean", "description": "Remember every mention across runs and return only what appeared since last time. Turn this on for scheduled monitoring.", "default": false }, "includeDomains": { "title": "Only these publishers", "type": "array", "description": "Keep only mentions from these domains, for example techcrunch.com. Subdomains are included.", "items": { "type": "string" } }, "excludeDomains": { "title": "Never these publishers", "type": "array", "description": "Drop mentions from these domains. Useful for filtering out aggregators and press release wires.", "items": { "type": "string" } }, "titleContains": { "title": "Headline contains", "type": "array", "description": "Keep only mentions whose headline contains one of these words.", "items": { "type": "string" } }, "titleExcludes": { "title": "Headline does not contain", "type": "array", "description": "Drop mentions whose headline contains one of these words.", "items": { "type": "string" } }, "since": { "title": "Only mentions after", "type": "string", "description": "A date such as 2026-08-01. Anything published before it is dropped." }, "language": { "title": "Language", "type": "string", "description": "Two letter language code for the news edition, for example en, de, fr.", "default": "en" }, "country": { "title": "Country edition", "type": "string", "description": "Two letter country code for the news edition, for example US, GB, DE.", "default": "US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Useful when watching many terms on a frequent schedule.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }