{ "openapi": "3.0.1", "info": { "title": "China Social Listening: Weibo, Douyin, RedNote, WeChat, News", "description": "Search Chinese social media and news for any keyword in one run: Weibo, Douyin, RedNote (Xiaohongshu), Toutiao, WeChat official accounts, news, forums and video sites. Filter by date (up to 90 days), platform, sentiment and content type. Pay per result.", "version": "1.0", "x-build-id": "iauWo5j7ggOmVzg4w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/qovia~china-social-listening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-qovia-china-social-listening", "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/qovia~china-social-listening/runs": { "post": { "operationId": "runs-sync-qovia-china-social-listening", "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/qovia~china-social-listening/run-sync": { "post": { "operationId": "run-sync-qovia-china-social-listening", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "One search per keyword. Separate words with spaces to require all of them (人工智能 教育). Chinese keywords match far more content than English ones.", "items": { "type": "string" } }, "platforms": { "title": "Platforms", "type": "array", "description": "Only these sources; all by default.", "items": { "type": "string", "enum": [ "weibo", "douyin", "toutiao", "xiaohongshu", "short_video", "wechat", "news", "forum", "long_video", "app" ], "enumTitles": [ "Weibo", "Douyin", "Toutiao", "RedNote (Xiaohongshu)", "Kuaishou and other short-video apps", "WeChat official accounts", "News sites and newspapers", "Forums and Tieba", "Bilibili and other video sites", "News apps" ] }, "default": [ "weibo", "douyin", "toutiao", "xiaohongshu", "short_video", "wechat", "news", "forum", "long_video", "app" ] }, "lastDays": { "title": "Last N days", "minimum": 1, "maximum": 90, "type": "integer", "description": "Content published in the last N days (Beijing time), up to 90. Ignored when 'From date' is set.", "default": 7 }, "dateFrom": { "title": "From date", "type": "string", "description": "Optional first day (YYYY-MM-DD, Beijing time). The window can be at most 90 days." }, "dateTo": { "title": "To date", "type": "string", "description": "Optional last day (YYYY-MM-DD, Beijing time); today by default." }, "maxItems": { "title": "Max results per keyword", "minimum": 1, "maximum": 1000, "type": "integer", "description": "The source returns up to 1,000 results per keyword (50 pages of 20).", "default": 100 }, "sentiment": { "title": "Sentiment", "type": "array", "description": "Only content with this sentiment; all by default.", "items": { "type": "string", "enum": [ "negative", "neutral", "positive" ], "enumTitles": [ "Negative", "Neutral", "Positive" ] }, "default": [ "negative", "neutral", "positive" ] }, "contentTypes": { "title": "Content types", "type": "array", "description": "Original posts, reposts and comments; all by default.", "items": { "type": "string", "enum": [ "original", "repost", "comment" ], "enumTitles": [ "Original posts", "Reposts", "Comments" ] }, "default": [ "original", "repost", "comment" ] }, "matchIn": { "title": "Match keywords in", "type": "array", "description": "Where the keywords must appear.", "items": { "type": "string", "enum": [ "title", "content", "author", "media_text", "audio" ], "enumTitles": [ "Title", "Text", "Author name", "Text in images and video", "Speech in audio and video" ] }, "default": [ "title", "content", "author" ] }, "excludeWords": { "title": "Exclude words", "type": "string", "description": "Leave out results that contain these words (separate with spaces)." }, "author": { "title": "Author", "type": "string", "description": "Only content published by this account name." } } }, "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 } } } } } } } } } }