{ "openapi": "3.0.1", "info": { "title": "Rakuten 楽天市場 Review VOC Collector", "description": "Complete, auditable Rakuten Ichiba review collection for VOC research. Batch selected products, crawl all review pages, and verify coverage with page/run audit records.", "version": "0.0", "x-build-id": "O2qNNozsoZfp7mkOm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/research_master~rakuten-review-voc/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-research_master-rakuten-review-voc", "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/research_master~rakuten-review-voc/runs": { "post": { "operationId": "runs-sync-research_master-rakuten-review-voc", "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/research_master~rakuten-review-voc/run-sync": { "post": { "operationId": "run-sync-research_master-rakuten-review-voc", "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": [ "products" ], "properties": { "products": { "title": "Selected products", "type": "array", "description": "Products to collect. Each item needs review_url, or both shop_id and item_id. Research identifiers are preserved in the output.", "items": { "type": "object", "properties": { "product_rank": { "title": "Product rank", "type": "integer", "description": "Optional rank in the research product universe." }, "item_key": { "title": "Item key", "type": "string", "description": "Recommended stable join key, for example shop-code:item-id." }, "item_id": { "title": "Item ID", "type": "string", "description": "Rakuten item ID. Required with shop_id when review_url is omitted." }, "shop_id": { "title": "Shop ID", "type": "integer", "description": "Numeric Rakuten shop ID. Required with item_id when review_url is omitted." }, "shop_code": { "title": "Shop code", "type": "string", "description": "Optional Rakuten shop code preserved in review rows." }, "item_name": { "title": "Item name", "type": "string", "description": "Optional snapshot name used as a fallback if the page omits it." }, "item_url": { "title": "Item URL", "type": "string", "description": "Optional Rakuten product URL preserved in the output." }, "review_url": { "title": "Review URL", "type": "string", "description": "Rakuten review page URL. Page 1 is normalized automatically." }, "price": { "title": "Price snapshot", "type": "number", "description": "Optional price snapshot used as a fallback." }, "review_average": { "title": "Review average snapshot", "type": "number", "description": "Optional rating snapshot used as a fallback." }, "review_count": { "title": "Review count snapshot", "type": "integer", "description": "Optional review-count snapshot for downstream comparison." } } }, "default": [] }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Parallel page requests. Reduce this if requests become unstable.", "default": 5 }, "max_pages_per_product": { "title": "Maximum pages per product", "minimum": 0, "type": "integer", "description": "Use 0 for every detected review page. Use a positive cap for a pilot or quick sample.", "default": 0 } } }, "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 } } } } } } } } } }