{ "openapi": "3.0.1", "info": { "title": "Asia Social Listening โ€“ HK, TW & SG Forum Brand Monitor", "description": "Monitor brand mentions across Asia's forums in one Actor: LIHKG (Hong Kong), PTT (Taiwan), HardwareZone (Singapore) and Telegram. Enter a keyword โ€” it searches, deduplicates and scores sentiment, with competitor share-of-voice. Priced per deduplicated mention. For SG/HK/TW social listening.", "version": "1.0", "x-build-id": "8XCQzjQFosqhgVEHv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/claude_code_reviewer~asia-social-listening-en/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-claude_code_reviewer-asia-social-listening-en", "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/claude_code_reviewer~asia-social-listening-en/runs": { "post": { "operationId": "runs-sync-claude_code_reviewer-asia-social-listening-en", "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/claude_code_reviewer~asia-social-listening-en/run-sync": { "post": { "operationId": "run-sync-claude_code_reviewer-asia-social-listening-en", "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": "The brand or keyword to monitor (required), e.g. \"iPhone\" (Eslite). All selected platforms search/filter using this term." }, "competitorBrands": { "title": "๐ŸฅŠ Competitor Brands", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "(Optional) Competitor brands/keywords โ€” each one also gets its own scrape pass. Use the output's brand_matched/is_competitor fields to compare share of voice.", "items": { "type": "string" } }, "searchAliases": { "title": "๐Ÿ”ค Primary Brand Aliases", "maxItems": 10, "uniqueItems": true, "type": "array", "description": "(Optional) Extra search terms for the primary brand โ€” English name, abbreviation, common misspellings, etc. Applies only to the primary brand (brandKeyword), not to competitors. When a post matches both the primary term and an alias, the primary term wins (matched_alias is null).", "items": { "type": "string" } }, "platforms": { "title": "๐Ÿ“ก Platforms to Monitor", "uniqueItems": true, "type": "array", "description": "Which platforms to monitor? LIHKG/Threads use true site-wide search; PTT/HardwareZone/Telegram filter by keyword within specific boards/forums/channels (requires the matching target list below).", "items": { "type": "string", "enum": [ "lihkg", "ptt", "hardwarezone", "telegram" ], "enumTitles": [ "LIHKG (Hong Kong ยท true search)", "PTT (Taiwan ยท in-board title filter)", "HardwareZone (Singapore ยท in-forum title filter)", "Telegram (in-channel text filter)" ] }, "default": [ "lihkg", "ptt", "hardwarezone", "telegram" ] }, "pttBoards": { "title": "๐Ÿ“‹ PTT Boards", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Applies when PTT is among the monitored platforms. Which boards to filter by title keyword within, e.g. Gossiping (general chat) or Stock. 18+ boards are handled automatically with the over18 cookie.", "items": { "type": "string" } }, "hwzForums": { "title": "๐Ÿ“‹ HardwareZone Forum IDs", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Applies when HardwareZone is among the monitored platforms. HardwareZone forum IDs (numeric), e.g. 16 (Eat-Drink-Man-Woman / EDMW).", "items": { "type": "string" } }, "telegramChannels": { "title": "๐Ÿ“‹ Telegram Channels", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Applies when Telegram is among the monitored platforms (required in that case, otherwise Telegram is skipped automatically with a warning). Enter the channel username without the @, e.g. durov. Only public channels can be scraped.", "items": { "type": "string" } }, "lookbackDays": { "title": "๐Ÿ“… Lookback Days", "minimum": 1, "maximum": 90, "type": "integer", "description": "Only scrape content from the last N days (based on post time / last reply time; paging stops early to save cost).", "default": 7 }, "maxMentionsPerPlatform": { "title": "๐Ÿ“Š Max Mentions per Platform per Brand", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of mentions to scrape per platform per brand (including competitors) โ€” this cap applies after merging the primary brand's aliases. Maximum 1000.", "default": 100 }, "sentimentAnalysis": { "title": "๐Ÿ™‚ Sentiment Analysis", "type": "boolean", "description": "When enabled, adds sentiment/sentiment_score to every mention. Determined with a lightweight Chinese/English keyword wordlist, not an AI model (see README for details). When disabled, both fields are null.", "default": true }, "deduplication": { "title": "๐Ÿงน Cross-Platform Deduplication", "type": "boolean", "description": "When enabled, flags the same post (same platform, same ID) and cross-platform reposts/duplicate content (identical normalized text) as is_duplicate. Only non-duplicate mentions are billed.", "default": true }, "deltaMode": { "title": "๐Ÿ†• Delta Mode", "type": "boolean", "description": "When enabled, only returns mentions new since the last run (tracked via a brand-specific named KV store recording seen mention_ids, compared across runs). Ideal for scheduled monitoring, avoiding repeat sightings of old data.", "default": false }, "proxyConfiguration": { "title": "๐ŸŒ Proxy (Apify datacenter proxy on by default)", "type": "object", "description": "Uses Apify datacenter proxy by default: without a proxy, you share egress IPs with other runs on the platform and are more likely to get rate-limited by individual platforms. Response payloads across all platforms are small, so proxy bandwidth cost is negligible. Turn it off only for your own proxy or local testing.", "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 } } } } } } } } } }