{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu Monitor", "description": "Monitor public Xiaohongshu and RedNote notes, tracked mentions, sample share of voice, and shop products in one dataset. Review source links, visible engagement, comparison metrics, prices, and exposed vendor details.", "version": "0.0", "x-build-id": "cH0B5GieeOa5BShG9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~xiaohongshu-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-xiaohongshu-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/maximedupre~xiaohongshu-monitor/runs": { "post": { "operationId": "runs-sync-maximedupre-xiaohongshu-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/maximedupre~xiaohongshu-monitor/run-sync": { "post": { "operationId": "run-sync-maximedupre-xiaohongshu-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": [ "resultType" ], "properties": { "resultType": { "title": "Result type", "enum": [ "note-observations", "mention-analysis", "share-of-voice", "shop-products" ], "type": "string", "description": "Choose the kind of result to collect in this run." }, "noteTargets": { "title": "Public note targets", "type": "array", "description": "For Note observations, add one or more public Xiaohongshu/RedNote note URLs. Use separate runs when you need separate scopes.", "items": { "type": "string", "pattern": "^https?://[^\\s]+$" } }, "breakoutThreshold": { "title": "Breakout threshold (%)", "minimum": 0, "type": "number", "description": "For Note observations, flag a post as a breakout when its observed engagement is at least this percentage above the available baseline." }, "shopTargets": { "title": "Public shop targets", "type": "array", "description": "For Shop products, add one or more publicly reachable Xiaohongshu/RedNote shop or vendor URLs. The run returns product identity, links, prices, discounts, currency, and exposed vendor context.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "For Shop products, keep products at or above this price. Leave empty to set no minimum." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "For Shop products, keep products at or below this price. Leave empty to set no maximum." }, "productOrder": { "title": "Product order", "enum": [ "relevance", "price-asc", "price-desc", "sales" ], "type": "string", "description": "For Shop products, choose how returned products are ordered." }, "sampleNoteTargets": { "title": "Public note sample", "type": "array", "description": "For Mention analysis and Share of voice, add public Xiaohongshu/RedNote note URLs to define the sample. Separate runs are needed for separate scopes.", "items": { "type": "string", "pattern": "^https?://[^\\s]+$" } }, "trackedEntities": { "title": "Brands and products to track", "type": "array", "description": "For Mention analysis and Share of voice, list the brands or products to compare. Each item needs a name and an entity type.", "items": { "type": "object", "properties": { "name": { "title": "Name", "type": "string", "description": "The public brand or product name to track.", "minLength": 1, "editor": "textfield" }, "type": { "title": "Entity type", "type": "string", "description": "Choose whether this item is a brand or a product.", "editor": "select", "enum": [ "brand", "product" ], "enumTitles": [ "Brand", "Product" ] } }, "required": [ "name", "type" ] } }, "mentionSpikeThreshold": { "title": "Mention spike threshold (%)", "minimum": 0, "type": "number", "description": "For Mention analysis and Share of voice, alert when mention volume changes by at least this percentage between observations." }, "anomalyThreshold": { "title": "Anomaly threshold (%)", "minimum": 0, "type": "number", "description": "Alert when monitored engagement, mention, or product values change by at least this percentage outside their recent observed range." }, "maxItems": { "title": "Maximum items", "minimum": 1, "type": "integer", "description": "Optional limit for results in this run. Leave empty to return all available results until the source is exhausted." } } }, "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 } } } } } } } } } }