{ "openapi": "3.0.1", "info": { "title": "Shopify Product Reviews Scraper — Judge.me, Okendo, Yotpo", "description": "Get the product reviews of any Shopify store that uses Judge.me, Okendo or Yotpo: star rating, title, text, date, verified buyer, helpful votes, photos and the shop's reply, per product. Filter by rating and date, and get only reviews new since your last run. No reviewer names.", "version": "0.1", "x-build-id": "CwmLCIfa3OdYf8Un4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/northbell~shopify-product-reviews/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-northbell-shopify-product-reviews", "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/northbell~shopify-product-reviews/runs": { "post": { "operationId": "runs-sync-northbell-shopify-product-reviews", "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/northbell~shopify-product-reviews/run-sync": { "post": { "operationId": "run-sync-northbell-shopify-product-reviews", "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": [ "stores" ], "properties": { "stores": { "title": "Stores or product pages", "type": "array", "description": "Shopify stores, one per line: \"www.brooklynbicycleco.com\" reads the store's reviews (Okendo: the whole store, newest first; Judge.me and Yotpo: the store's products in its own order); a product page like \"https://www.mvmt.com/products/odyssey-ii-ceramic-fusion-grey-40mm-28000461\" reads just that product. The store must use Judge.me, Okendo or Yotpo for its reviews; other stores get a free error row saying which review app they use.", "items": { "type": "string" } }, "maxProductsPerStore": { "title": "Products per store", "minimum": 1, "maximum": 2000, "type": "integer", "description": "How many products to read reviews for, in the order of the store's product list (Judge.me and Yotpo stores). Okendo stores are read newest review first across all products, up to Reviews per store. Ignored for product pages.", "default": 30 }, "maxReviewsPerProduct": { "title": "Reviews per product", "minimum": 1, "maximum": 5000, "type": "integer", "description": "The most reviews to return for one product, newest first.", "default": 100 }, "maxReviewsPerStore": { "title": "Reviews per store", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop a store after this many reviews.", "default": 1000 }, "minRating": { "title": "Lowest rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at least this many stars.", "default": 1 }, "maxRating": { "title": "Highest rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only reviews with at most this many stars. Set it to 2 to get the complaints.", "default": 5 }, "reviewedWithinDays": { "title": "Reviewed within (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only reviews written in the last N days. 0 means any date.", "default": 0 }, "output": { "title": "What to return", "enum": [ "all", "new" ], "type": "string", "description": "With \"Only new\", reviews returned by an earlier run for the same store are left out and not charged. The first run returns everything, because there is nothing to compare with yet.", "default": "all" } } }, "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 } } } } } } } } } }