{ "openapi": "3.0.1", "info": { "title": "Universal Shopify Review Scraper", "description": "Shopify review scraper and review app detector for Okendo, Yotpo, Judge.me, Stamped.io, TestFreaks, and Junip. Automatically identify the review platform used by any Shopify store and extract product reviews, ratings, reviewer data, photos, videos, and review metadata for ecommerce research.", "version": "0.1", "x-build-id": "0WafqybUN1ZcRZmBF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yogeshpandar~universal-shopify-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yogeshpandar-universal-shopify-review-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/yogeshpandar~universal-shopify-review-scraper/runs": { "post": { "operationId": "runs-sync-yogeshpandar-universal-shopify-review-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/yogeshpandar~universal-shopify-review-scraper/run-sync": { "post": { "operationId": "run-sync-yogeshpandar-universal-shopify-review-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": [ "storeDomains" ], "properties": { "storeDomains": { "title": "Store domains or URLs", "type": "array", "description": "Enter one or more Shopify store domains or URLs. Examples: snif.co, drsquatch.com, https://truebotanicals.com", "items": { "type": "string", "minLength": 3 } }, "mode": { "title": "Mode", "enum": [ "balanced", "fast" ], "type": "string", "description": "Fast mode prioritizes speed with higher concurrency. Balanced mode is more conservative.", "default": "balanced" }, "maxReviews": { "title": "Max reviews per store", "minimum": 1, "type": "integer", "description": "Optional cap per store. Leave empty to scrape until platform pagination ends or maxPages is reached." }, "outputFormat": { "title": "Output format", "enum": [ "dataset", "files", "both" ], "type": "string", "description": "Dataset pushes review rows. Files stores JSON/CSV in key-value store. Both does both.", "default": "dataset" }, "includeEmptyStatusItems": { "title": "Add dataset status rows for empty stores", "type": "boolean", "description": "When enabled, stores with no collected reviews still add a status row to the dataset.", "default": false }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard pagination cap for provider APIs.", "default": 500 }, "timeoutSeconds": { "title": "Request timeout", "minimum": 3, "maximum": 120, "type": "integer", "description": "Per-request timeout in seconds.", "default": 12 }, "retries": { "title": "Retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "Retry attempts per request.", "default": 3 }, "delay": { "title": "Delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Base delay between slower pagination requests in milliseconds.", "default": 200 }, "globalInflight": { "title": "Global concurrency", "minimum": 1, "maximum": 64, "type": "integer", "description": "Maximum concurrent HTTP requests. Fast mode may tune this upward.", "default": 12 }, "perHostInflight": { "title": "Per-host concurrency", "minimum": 1, "maximum": 16, "type": "integer", "description": "Maximum concurrent HTTP requests per host. Fast mode may tune this upward.", "default": 4 }, "maxJsFiles": { "title": "Max external JS files", "minimum": 0, "maximum": 200, "type": "integer", "description": "Upper bound for review-relevant JavaScript files fetched during detection.", "default": 40 }, "detectionProductPages": { "title": "Detection product pages", "minimum": 0, "maximum": 50, "type": "integer", "description": "Number of product pages sampled during platform detection.", "default": 8 }, "detectionMaxProductFetch": { "title": "Detection product fetch cap", "minimum": 0, "maximum": 200, "type": "integer", "description": "Hard cap for product pages fetched during detection.", "default": 30 }, "httpBackend": { "title": "HTTP backend", "enum": [ "auto", "requests", "httpx" ], "type": "string", "description": "HTTP client backend.", "default": "auto" }, "parserBackend": { "title": "HTML parser", "enum": [ "auto", "bs4", "selectolax" ], "type": "string", "description": "HTML parser backend.", "default": "auto" }, "jsonBackend": { "title": "JSON backend", "enum": [ "auto", "json", "orjson" ], "type": "string", "description": "JSON parser/serializer backend.", "default": "auto" }, "diskCacheEnabled": { "title": "Enable disk cache", "type": "boolean", "description": "Cache HTTP responses within the current Actor run filesystem.", "default": false }, "diskCacheTtlSeconds": { "title": "Disk cache TTL", "minimum": 60, "maximum": 86400, "type": "integer", "description": "Time-to-live for cached responses.", "default": 1800 }, "memoryCacheEnabled": { "title": "Enable memory cache", "type": "boolean", "description": "Cache duplicate HTTP requests in memory during each store run.", "default": true } } }, "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 } } } } } } } } } }