{ "openapi": "3.0.1", "info": { "title": "nopCommerce Reviews Scraper & Change Monitor", "description": "Build a review dataset from public nopCommerce product pages. Export JSON or CSV and monitor changes. $0.6 per 1,000 rows plus $0.001 per run.", "version": "0.3", "x-build-id": "duDQ6ovnMyvKMprm0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clintsa~nopcommerce-product-review-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clintsa-nopcommerce-product-review-extractor", "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/clintsa~nopcommerce-product-review-extractor/runs": { "post": { "operationId": "runs-sync-clintsa-nopcommerce-product-review-extractor", "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/clintsa~nopcommerce-product-review-extractor/run-sync": { "post": { "operationId": "run-sync-clintsa-nopcommerce-product-review-extractor", "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": [ "targets" ], "properties": { "targets": { "title": "nopCommerce product or store URLs", "type": "array", "description": "Public product, category, storefront, sitemap, ProductReviewsTab or productreviews URLs. Accepts strings or catalog objects with url, id and name. Numeric IDs need storeUrl." }, "storeUrl": { "title": "Store URL for numeric product IDs", "type": "string", "description": "Optional public storefront base URL, including any installation or locale prefix. Required when targets contains bare product IDs." }, "maxItemsPerProduct": { "title": "Maximum exported reviews per product", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Output row limit per product after full review scanning and monitoring. Use 0 for all fetched review rows; removal events also count toward the limit.", "default": 100 }, "maxProducts": { "title": "Maximum products per target", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum distinct products discovered from each target. Prefer direct product URLs for a quick run.", "default": 20 }, "maxDiscoveryPages": { "title": "Maximum discovery pages per target", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum pages inspected for products, including the starting URL and product pages. Discovery bounds do not imply a complete catalog.", "default": 30 }, "maxReviewPages": { "title": "Maximum review pages per product", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum recognized review pages followed per product. A capped scan retains unseen prior reviews and emits no removal events.", "default": 20 }, "maxRequests": { "title": "Maximum HTTP requests per target", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Bounds HTTP operations including robots, redirects, discovery and review requests. A transient retry can add up to two network attempts per operation.", "default": 200 }, "requestDelayMillis": { "title": "Request delay (milliseconds)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Minimum delay between sequential requests to a target. Robots crawl delays are also respected. No proxy is used.", "default": 250 }, "minRating": { "title": "Minimum star rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Output-only rating filter, 1 to 5. Use 0 to also include reviews whose public rating is missing. Monitoring still snapshots all fetched reviews.", "default": 0 }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Output-only upper star rating, 1 to 5. Set to 2 to focus on low ratings.", "default": 5 }, "monitorId": { "title": "Review monitor ID", "type": "string", "description": "Persistent namespace for review snapshots across runs. Keep it for a schedule; change it to start a separate baseline.", "default": "default" }, "onlyChangesSince": { "title": "Only changes since", "type": "string", "description": "Optional ISO 8601 timestamp; exports only new, updated and removed review events detected since that time." } } }, "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 } } } } } } } } } }