# Brand Mention Share-of-Voice Monitor (`kayhermes/brand-mention-share-of-voice-monitor`) Actor - **URL**: https://apify.com/kayhermes/brand-mention-share-of-voice-monitor.md - **Developed by:** [Khoa Nguyen](https://apify.com/kayhermes) (community) - **Categories:** Social media - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Brand Mention Share-of-Voice Monitor Deduplicate and classify supplied public mentions, calculate raw and reach-weighted share of voice, source and time breakdowns, sentiment, and persistent change alerts versus a previous run. ### What it actually does Matched mention records, brand summaries, weighted share of voice, sentiment metrics, and regression alerts. Supports inline JSON, an Apify Dataset, and public/signed JSON or CSV URLs. Source collection from social platforms is intentionally decoupled so users can connect any permitted scraper or export. ### Inputs Use `mentions[]`, `datasetId`, or `sourceUrls`. See `sample_input.json` and the Apify input schema for exact fields. ### Outputs - Default Dataset: detailed result rows and a run summary - `OUTPUT`: machine-readable run summary - `REPORT.html`: reviewable HTML report ### Limitations Share of voice measures only the supplied coverage. It is not a complete census unless source collection is comprehensive. The Actor analyzes supplied data; it does not bypass platform access controls or guarantee that upstream data is complete. ### Local validation ```bash npm ci npm test npm run check npm start ```` ### Deploy ```bash apify login apify push ``` Use `APIFY_TOKEN` from secure environment storage. Never commit credentials. # Actor input Schema ## `mentions` (type: `array`): Public mention records from social, news, review, forum, or web datasets. ## `brands` (type: `array`): At least two brands. The first brand is treated as primary unless isPrimary is set. ## `datasetId` (type: `string`): Provide Source Dataset ID. ## `sourceUrls` (type: `array`): Provide CSV or JSON source URLs. ## `config` (type: `object`): Set time granularity, sourceMultipliers and reach/engagement weights. ## `alerts` (type: `object`): Provide Alert thresholds. ## `historyStoreName` (type: `string`): Provide Persistent history store. ## `historyKey` (type: `string`): Provide History key. ## `maxItems` (type: `integer`): Provide Maximum mentions. ## `webhookUrl` (type: `string`): Provide Alert webhook. ## Actor input object example ```json { "mentions": [ { "id": "m1", "text": "AlphaTea launched a great summer drink", "source": "instagram", "publishedAt": "2026-07-01", "reach": 10000, "engagement": 800, "sentiment": "positive", "url": "https://example.com/a" }, { "id": "m2", "text": "BetaBoba opening got huge crowds", "source": "tiktok", "publishedAt": "2026-07-02", "reach": 100000, "engagement": 10000, "sentiment": 0.7, "url": "https://example.com/b" } ], "brands": [ { "name": "Alpha Tea", "aliases": [ "AlphaTea" ], "isPrimary": true }, { "name": "Beta Boba", "aliases": [ "BetaBoba" ] } ], "sourceUrls": [], "config": { "granularity": "day", "reachWeight": 0.65, "engagementWeight": 0.35 }, "alerts": { "shareDropAlertPoints": 5, "sentimentDropAlert": 0.2, "newBrandAlertShare": 5 }, "historyStoreName": "brand-mention-share-of-voice-history", "historyKey": "LATEST", "maxItems": 50000 } ``` # Actor output Schema ## `results` (type: `string`): No description ## `reportUrl` (type: `string`): No description ## `summaryUrl` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("kayhermes/brand-mention-share-of-voice-monitor").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("kayhermes/brand-mention-share-of-voice-monitor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call kayhermes/brand-mention-share-of-voice-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=kayhermes/brand-mention-share-of-voice-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Brand Mention Share-of-Voice Monitor", "version": "2.0", "x-build-id": "NkKEHS99amKORqgDn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kayhermes~brand-mention-share-of-voice-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kayhermes-brand-mention-share-of-voice-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/kayhermes~brand-mention-share-of-voice-monitor/runs": { "post": { "operationId": "runs-sync-kayhermes-brand-mention-share-of-voice-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/kayhermes~brand-mention-share-of-voice-monitor/run-sync": { "post": { "operationId": "run-sync-kayhermes-brand-mention-share-of-voice-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": [ "brands" ], "properties": { "mentions": { "title": "Mention records", "type": "array", "description": "Public mention records from social, news, review, forum, or web datasets.", "default": [ { "id": "m1", "text": "AlphaTea launched a great summer drink", "source": "instagram", "publishedAt": "2026-07-01", "reach": 10000, "engagement": 800, "sentiment": "positive", "url": "https://example.com/a" }, { "id": "m2", "text": "BetaBoba opening got huge crowds", "source": "tiktok", "publishedAt": "2026-07-02", "reach": 100000, "engagement": 10000, "sentiment": 0.7, "url": "https://example.com/b" } ] }, "brands": { "title": "Brands and aliases", "type": "array", "description": "At least two brands. The first brand is treated as primary unless isPrimary is set.", "default": [ { "name": "Alpha Tea", "aliases": [ "AlphaTea" ], "isPrimary": true }, { "name": "Beta Boba", "aliases": [ "BetaBoba" ] } ] }, "datasetId": { "title": "Source Dataset ID", "type": "string", "description": "Provide Source Dataset ID." }, "sourceUrls": { "title": "CSV or JSON source URLs", "type": "array", "description": "Provide CSV or JSON source URLs.", "default": [], "items": { "type": "string" } }, "config": { "title": "Weighting options", "type": "object", "description": "Set time granularity, sourceMultipliers and reach/engagement weights.", "default": { "granularity": "day", "reachWeight": 0.65, "engagementWeight": 0.35 } }, "alerts": { "title": "Alert thresholds", "type": "object", "description": "Provide Alert thresholds.", "default": { "shareDropAlertPoints": 5, "sentimentDropAlert": 0.2, "newBrandAlertShare": 5 } }, "historyStoreName": { "title": "Persistent history store", "type": "string", "description": "Provide Persistent history store.", "default": "brand-mention-share-of-voice-history" }, "historyKey": { "title": "History key", "type": "string", "description": "Provide History key.", "default": "LATEST" }, "maxItems": { "title": "Maximum mentions", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Provide Maximum mentions.", "default": 50000 }, "webhookUrl": { "title": "Alert webhook", "type": "string", "description": "Provide Alert webhook." } } }, "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 } } } } } } } } } } ```