{ "openapi": "3.0.1", "info": { "title": "Brand Mention Monitor: News, Reddit, YouTube & Hacker News", "description": "Find public brand mentions across news, Reddit search results, YouTube, Hacker News, blogs, forums and reviews. Get new-only monitoring, sentiment cues, relevance reasons, competitor share of voice and a client HTML report. Pay for delivered mentions.", "version": "0.1", "x-build-id": "3TbyTAdyvoIdfftt8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zaiq~brand-mention-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zaiq-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/zaiq~brand-mention-monitor/runs": { "post": { "operationId": "runs-sync-zaiq-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/zaiq~brand-mention-monitor/run-sync": { "post": { "operationId": "run-sync-zaiq-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", "properties": { "brandTerms": { "title": "Brand terms", "type": "array", "description": "Primary brand name and up to four alternative spellings. All terms belong to the same primary brand. Empty input uses the generic demonstration query open source.", "items": { "type": "string" }, "default": [] }, "contextWords": { "title": "Required context", "type": "array", "description": "Every word or phrase must appear in the visible title or text. Use these to disambiguate common brand names. Applied equally to competitors and reviews.", "items": { "type": "string" }, "default": [] }, "negativeWords": { "title": "Exclude words", "type": "array", "description": "Reject any mention containing one of these whole words or phrases. Case insensitive.", "items": { "type": "string" }, "default": [] }, "ownDomains": { "title": "Exclude own websites", "type": "array", "description": "Website domains to exclude from results and search queries (your own sites).", "items": { "type": "string" }, "default": [] }, "competitorBrands": { "title": "Competitor brands", "type": "array", "description": "Up to five competing brands, each searched separately under the same source and context settings. Share of voice describes the retrieved sample.", "items": { "type": "string" }, "default": [] }, "sources": { "title": "Sources", "type": "array", "description": "News, Reddit and web use Google’s index (web includes blogs and forums). YouTube and Hacker News are read directly. The default is the two direct sources, for a fast first run.", "items": { "type": "string", "enum": [ "news", "reddit", "web", "youtube", "hackernews" ], "enumTitles": [ "News", "Reddit (Google index)", "Web, blogs and forums", "YouTube", "Hacker News" ] }, "default": [ "hackernews", "youtube" ] }, "timeWindow": { "title": "Time window", "enum": [ "day", "week", "month", "since-last-run" ], "type": "string", "description": "Publication window where a date is shown. Google’s date filter can reflect indexing dates. Since last run uses the last completed scan with a one-day overlap, limited to 30 days; the first scan uses seven days.", "default": "week" }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code for Google and YouTube search context. Does not establish where a writer or audience lives.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Search language code, for example en. English sentiment uses deterministic cue words; other languages use review stars or remain neutral and unclassified.", "default": "en" }, "maxMentions": { "title": "Maximum mentions", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum unique mentions delivered across all tracked brands and sources. Competitor mentions count toward this limit.", "default": 50 }, "maxPagesPerSource": { "title": "Pages per source and brand", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum pages per source per searched brand group. Stops early when a source ends, repeats or two pages yield no new matches. Lower values bound sparse search costs.", "default": 2 }, "includeUndated": { "title": "Include mentions without a date", "type": "boolean", "description": "Include undated search results with an explicit unknown-date note. Turn off for a strict published-date window.", "default": true }, "monitorStoreName": { "title": "Monitoring store", "type": "string", "description": "Optional stable name for new-only tracking across scheduled runs. Use one active run per store and query scope. Changing matching inputs starts a separate history. Keep this blank for an independent scan.", "default": "" }, "newOnly": { "title": "Only new mentions", "type": "boolean", "description": "With a monitoring store, suppress mentions delivered by an earlier run. The first run establishes the baseline and delivers its matches. Without a store, all matches are new to this run.", "default": 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 }, "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 } } } } } } } } } }