{ "openapi": "3.0.1", "info": { "title": "Shopify Reviews Scraper (Judge.me, Yotpo, Okendo, Loox)", "description": "Scrape product and store reviews from Shopify stores using Judge.me, Yotpo, Okendo or Loox. Paste a store domain or product URL; the review app is detected automatically. Get rating, title, text, date, verified buyer, helpful votes and replies, plus optional insights. Export CSV, Excel or JSON.", "version": "0.1", "x-build-id": "nG7JH9byQdBnayWGw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bozomalabs~shopify-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bozomalabs-shopify-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/bozomalabs~shopify-reviews-scraper/runs": { "post": { "operationId": "runs-sync-bozomalabs-shopify-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/bozomalabs~shopify-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-bozomalabs-shopify-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", "properties": { "startUrls": { "title": "Store domains or product URLs", "type": "array", "description": "A store homepage (e.g. pupford.com) for all store reviews, or a product URL (https://store.com/products/handle) for that product's reviews. A Loox widget URL (https://loox.io/widget/ID/reviews) also works, as do direct public widget IDs: okendo:, yotpo:, judgeme:.myshopify.com, loox:.", "items": { "type": "string" } }, "maxReviewsPerTarget": { "title": "Max reviews per URL", "minimum": 0, "type": "integer", "description": "Stop after this many reviews per store or product (after filters). 0 means no limit.", "default": 500 }, "provider": { "title": "Review app", "enum": [ "auto", "judgeme", "yotpo", "okendo", "loox" ], "type": "string", "description": "Leave on Auto to detect from the page. Force one if a store has several apps installed.", "default": "auto" }, "stars": { "title": "Star filter", "type": "array", "description": "Keep only these star ratings. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] }, "default": [] }, "dateFrom": { "title": "Reviews from date", "type": "string", "description": "Keep reviews published on or after this date (YYYY-MM-DD). Loox does not publish review dates, so this is ignored there." }, "dateTo": { "title": "Reviews up to date", "type": "string", "description": "Keep reviews published on or before this date (YYYY-MM-DD)." }, "verifiedOnly": { "title": "Verified buyers only", "type": "boolean", "description": "Keep only reviews the review app marks as verified purchases.", "default": false }, "includeReplies": { "title": "Include store replies", "type": "boolean", "description": "Add replyText and replyDate columns when the store replied publicly.", "default": true }, "omitReviewerNames": { "title": "Omit reviewer names", "type": "boolean", "description": "Leave reviewerName empty, for privacy-friendly exports.", "default": false }, "insights": { "title": "Add review insights (paid add-on)", "type": "boolean", "description": "Per URL: rating breakdown, monthly trend, top complaint and praise phrases, feature requests and lowest-rated products, saved to the INSIGHTS record in the run's key-value store. Charged once per URL.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Usually not needed.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }