{ "openapi": "3.0.1", "info": { "title": "AliExpress Reviews Scraper", "description": "Collect the public reviews on any AliExpress product: star rating, the shopper's own words plus an English translation, buyer country, the exact variant bought, photos and after-sale follow-ups. One product or a thousand, with the full star breakdown for each.", "version": "0.0", "x-build-id": "r7wDzOBN3DQDcjmLZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apt_marble~aliexpress-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apt_marble-aliexpress-reviews-scraper", "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/apt_marble~aliexpress-reviews-scraper/runs": { "post": { "operationId": "runs-sync-apt_marble-aliexpress-reviews-scraper", "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/apt_marble~aliexpress-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-apt_marble-aliexpress-reviews-scraper", "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": [ "productUrls" ], "properties": { "productUrls": { "title": "Product links or product numbers", "type": "array", "description": "One AliExpress product per line. Paste the product link, or just the product number from it. Anything that is not an AliExpress product is skipped and counted in the run summary.", "default": [ "https://www.aliexpress.com/item/1005007805726069.html" ], "items": { "type": "string" } }, "reviewSet": { "title": "Which reviews to collect", "enum": [ "complete", "everything_single_pass", "positive", "critical", "with_photos", "after_sale", "from_selected_country" ], "type": "string", "description": "Choose the slice of the product's public reviews you want. \"Everything\" walks the reviews star band by star band, which reaches far more of a heavily reviewed product than a straight run through the list does.", "default": "complete" }, "maxReviewsPerProduct": { "title": "Maximum reviews per product", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Stop after this many reviews for each product. Products with fewer public reviews return everything they publish.", "default": 100 }, "includeAfterSaleFollowUps": { "title": "Include after-sale follow-ups", "type": "boolean", "description": "Also collect the follow-up comments shoppers add weeks after their first review, and attach the follow-up text to those reviews. Applies to the two \"Everything\" options.", "default": true }, "includeProductSummary": { "title": "Add one summary row per product", "type": "boolean", "description": "Adds a single extra row per product holding the average score, the full star breakdown, how many reviews the product publishes in each slice, and the phrases shoppers mention most. Summary rows count as results.", "default": true }, "country": { "title": "Country edition to read", "enum": [ "es", "de", "fr", "it", "nl", "pl", "gb", "ca", "au", "br", "mx", "cl", "ru", "sa", "ae", "il", "kr", "jp", "in", "sg", "za" ], "type": "string", "description": "Which country's edition of the product's review pages to read. It sets the order reviews come back in, and it is the country used by the \"reviews from shoppers in the selected country\" option. The United States edition is not offered because it reports every reviewer as being in the United States and withholds review photos.", "default": "es" }, "productsAtOnce": { "title": "How many products at once", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many products to work through in parallel. Higher is faster, but the source site is more likely to slow the run down.", "default": 2 } } }, "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 } } } } } } } } } }