{ "openapi": "3.0.1", "info": { "title": "Chinese Brand Monitor: Weibo + RedNote + Bilibili Aggregator", "description": "Track brand mentions across China's top 5 social/content platforms in a single call. Normalized output, sentiment-tagged, cross-platform deduplicated. Enterprise-grade coverage at $0.045/mention. Built for brand monitoring agencies, DTC e-commerce, China-watcher funds.", "version": "0.5", "x-build-id": "zB6fOk6YJM0NHAXos" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~chinese-brand-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-chinese-brand-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/zhorex~chinese-brand-monitor/runs": { "post": { "operationId": "runs-sync-zhorex-chinese-brand-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/zhorex~chinese-brand-monitor/run-sync": { "post": { "operationId": "run-sync-zhorex-chinese-brand-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": [ "brandKeyword" ], "properties": { "brandKeyword": { "title": "Brand keyword", "type": "string", "description": "Brand name in Chinese or English. Accepts both — e.g. '李宁', 'Li-Ning', 'Apple', '耐克', 'NIKE'. For best recall on bilingual brands, run twice (once per language) and merge." }, "platforms": { "title": "Platforms", "uniqueItems": true, "type": "array", "description": "Subset of platforms to query. Default: all five. Disabling platforms lowers cost and runtime.", "items": { "type": "string", "enum": [ "weibo", "bilibili", "rednote", "douban", "xueqiu" ], "enumTitles": [ "Weibo (微博) — microblog", "Bilibili (B站) — video", "RedNote (小红书 / Xiaohongshu) — lifestyle", "Douban (豆瓣) — reviews & groups", "Xueqiu (雪球) — stock/cashtag sentiment" ] }, "default": [ "weibo", "bilibili", "rednote", "douban", "xueqiu" ] }, "maxMentionsPerPlatform": { "title": "Max mentions per platform", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on mentions returned per platform. Controls cost and runtime.", "default": 100 }, "lookbackDays": { "title": "Lookback window (days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Recency filter. Applied per platform on a best-effort basis — some platforms don't expose a server-side date filter (we discard older mentions client-side).", "default": 7 }, "sentimentAnalysis": { "title": "Sentiment analysis", "type": "boolean", "description": "Run lexicon-based Chinese sentiment scoring on each mention. Adds polarity (positive/neutral/negative) and a -1.0…+1.0 score. Disable to reduce runtime by ~5%.", "default": true }, "deduplication": { "title": "Cross-platform deduplication", "type": "boolean", "description": "Detect near-duplicate brand mentions reposted across platforms within 24h. Duplicates are merged into the canonical mention's crossPlatformReposts array. Billed only on canonical records.", "default": true }, "cookieStrings": { "title": "Per-platform cookies (optional)", "type": "object", "description": "Optional cookie strings keyed by platform name (weibo / bilibili / rednote / douban / xueqiu). Unlocks higher recall and rate limits where supported. Format: paste the raw Cookie header value from your browser's DevTools. Not required — the actor degrades gracefully when omitted." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. RESIDENTIAL with CN country is recommended for the highest recall and lowest rate-limit risk.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "CN" } } } }, "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 } } } } } } } } } }