{ "openapi": "3.0.1", "info": { "title": "WeChat Brand Mention & Share-of-Voice Monitor", "description": "Monitor brand and competitor mentions in public WeChat Official Account articles. Get evidence URLs, share of voice, new mentions, risk alerts, top publishers, and co-mentions—without a WeChat Cookie.", "version": "0.1", "x-build-id": "HBgDf1UER1VFquTQj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrupulous_buckler~wechat-brand-mention-share-of-voice-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrupulous_buckler-wechat-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/scrupulous_buckler~wechat-brand-mention-share-of-voice-monitor/runs": { "post": { "operationId": "runs-sync-scrupulous_buckler-wechat-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/scrupulous_buckler~wechat-brand-mention-share-of-voice-monitor/run-sync": { "post": { "operationId": "run-sync-scrupulous_buckler-wechat-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", "properties": { "mode": { "title": "Data source", "enum": [ "demo", "liveSearch", "dataset", "uploadedRecords" ], "type": "string", "description": "Preview a static example without the report fee, search public WeChat articles through Sogou, analyze Apify datasets, or paste your own article records.", "default": "demo" }, "brandName": { "title": "Primary brand", "type": "string", "description": "The brand whose WeChat mentions you want to monitor. Required outside demo mode.", "default": "" }, "brandAliases": { "title": "Primary-brand aliases", "type": "array", "description": "Up to 9 alternative spellings, Chinese/English names, abbreviations, product lines, or campaign names that should count toward the primary brand.", "default": [], "items": { "type": "string" } }, "competitorBrands": { "title": "Competitor brands", "type": "array", "description": "Up to 10 competitor names. Each competitor receives its own mention count and share-of-voice row.", "default": [], "items": { "type": "string" } }, "riskKeywords": { "title": "Risk and issue keywords", "type": "array", "description": "Literal terms used to flag possible complaints, safety issues, refunds, recalls, or reputation risks.", "default": [ "投诉", "质量问题", "虚假宣传", "召回", "维权", "退款", "过敏", "副作用" ], "items": { "type": "string" } }, "lookbackDays": { "title": "Lookback window in days", "minimum": 7, "maximum": 365, "type": "integer", "description": "Articles with a valid date outside this window are excluded.", "default": 90 }, "maxResults": { "title": "Maximum current articles to inspect", "minimum": 1, "maximum": 100, "type": "integer", "description": "Limits discovery or uploaded articles inspected before literal mention matching.", "default": 100 }, "maxMentions": { "title": "Maximum mention rows", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum paid-delivery mention rows. One report includes up to 100 literal mentions.", "default": 100 }, "sourceDatasetIds": { "title": "Current Apify Dataset IDs", "type": "array", "description": "Dataset IDs containing current WeChat article records. Required only in dataset mode; up to 10 datasets.", "default": [], "items": { "type": "string" } }, "uploadedRecords": { "title": "Current uploaded article records", "type": "array", "description": "Paste JSON article records. Common English, Chinese, and Sogou scraper field names are recognized.", "default": [] }, "priorDatasetId": { "title": "Prior Dataset ID for new-mention comparison", "type": "string", "description": "Optional earlier snapshot. When supplied, the report marks new mentions and compares current versus previous counts.", "default": "" }, "baselineRecords": { "title": "Uploaded baseline article records", "type": "array", "description": "Optional earlier article snapshot for new-mention and mention-count comparison.", "default": [] }, "maxEvidence": { "title": "Maximum evidence rows per report section", "minimum": 3, "maximum": 30, "type": "integer", "description": "Limits evidence-linked examples in risk and new-mention sections.", "default": 10 } } }, "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 } } } } } } } } } }