{ "openapi": "3.0.1", "info": { "title": "Yotpo Review Scraper for Shopify stores", "description": "Scrape Yotpo reviews from any Shopify store: rating, title, text, photos, videos, author, date and product. Store-wide or per product. No login, no API key. JSON, CSV or Excel.", "version": "0.2", "x-build-id": "hUZn1Cn3nPtCdtJTh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stanvanrooy6~yotpo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stanvanrooy6-yotpo-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/stanvanrooy6~yotpo-scraper/runs": { "post": { "operationId": "runs-sync-stanvanrooy6-yotpo-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/stanvanrooy6~yotpo-scraper/run-sync": { "post": { "operationId": "run-sync-stanvanrooy6-yotpo-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": "Start URLs", "type": "array", "description": "List of Shopify store URLs or specific product URLs to scrape reviews from.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxReviews": { "title": "Max Reviews", "minimum": 0, "type": "integer", "description": "Maximum number of reviews to scrape per URL. Set 0 for all available reviews (up to about 20,000 per store or product).", "default": 100 }, "debug": { "title": "Debug Mode", "type": "boolean", "description": "Enable verbose logging for debugging purposes.", "default": false }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews within the inclusive star range. Leave blank for any rating." }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews within the inclusive star range. Leave blank for any rating." }, "reviewDateFrom": { "title": "Reviews from", "type": "string", "description": "Optional ISO date (YYYY-MM-DD) or timestamp. Inclusive; date-only boundaries use UTC and the end date includes the entire day. Reviews with unknown dates are excluded." }, "reviewDateTo": { "title": "Reviews through", "type": "string", "description": "Optional ISO date (YYYY-MM-DD) or timestamp. Inclusive; date-only boundaries use UTC and the end date includes the entire day. Reviews with unknown dates are excluded." }, "reviewText": { "title": "Review text contains", "type": "string", "description": "Case-insensitive phrase in the title or body." }, "verifiedOnly": { "title": "Verified buyers only", "type": "boolean", "description": "Exclude reviews without a confirmed verified-buyer flag.", "default": false }, "mediaOnly": { "title": "Photos or videos only", "type": "boolean", "description": "Keep reviews with at least one photo or video supplied by the review app.", "default": false }, "maxScannedReviews": { "title": "Maximum reviews to scan with filters", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Total source reviews checked across all URLs when filters are active. Stops work even if there are fewer matches than maxReviews. Rejected reviews are not saved or charged as results. Without filters this setting has no effect.", "default": 10000 } } }, "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 } } } } } } } } } }