{ "openapi": "3.0.1", "info": { "title": "Shopify App Reviews Scraper — Ratings & Monitor", "description": "Shopify App Store reviews scraper plus competitor ranking intelligence. Export reviews, merchant usage, ratings and developer replies; discover apps by keyword, category or developer profile, capture app rankings and metadata, filter feedback, and monitor only newly appearing reviews.", "version": "0.2", "x-build-id": "rahwTiTOOtigco4Gf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zenomastro~shopify-app-reviews-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zenomastro-shopify-app-reviews-intelligence", "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/zenomastro~shopify-app-reviews-intelligence/runs": { "post": { "operationId": "runs-sync-zenomastro-shopify-app-reviews-intelligence", "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/zenomastro~shopify-app-reviews-intelligence/run-sync": { "post": { "operationId": "run-sync-zenomastro-shopify-app-reviews-intelligence", "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": { "apps": { "title": "App handles or Shopify App Store URLs", "minItems": 0, "maxItems": 50, "type": "array", "description": "Direct app handles or Shopify App Store URLs. Optional when using keyword/category/developer discovery.", "default": [ "klaviyo-email-marketing" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum reviews per app. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 500 }, "maxPagesPerApp": { "title": "Maximum pages per app", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum pages per app. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 50 }, "ratings": { "title": "Ratings to keep (1-5)", "type": "array", "description": "Ratings to keep (1-5). Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Review text keywords", "type": "array", "description": "Review text keywords. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": [], "items": { "type": "string" } }, "countries": { "title": "Merchant countries", "type": "array", "description": "Merchant countries. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": [], "items": { "type": "string" } }, "includeDeveloperReplies": { "title": "Include developer replies", "type": "boolean", "description": "Include developer replies. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": true }, "monitorKey": { "title": "Persistent monitor key", "type": "string", "description": "Persistent monitor key. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use." }, "onlyNew": { "title": "Emit only unseen reviews", "type": "boolean", "description": "Emit only unseen reviews. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": false }, "stopWhenSeen": { "title": "Stop paging once a page has no unseen reviews", "type": "boolean", "description": "Stop paging once a page has no unseen reviews. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": true }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 5, "maximum": 120, "type": "integer", "description": "Request timeout. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 25 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries. Configure this value to control the Actor run; bounded defaults are chosen for reliable production use.", "default": 2 }, "dateFrom": { "title": "Review date from (YYYY-MM-DD)", "type": "string", "description": "Keep reviews on or after this date." }, "dateTo": { "title": "Review date to (YYYY-MM-DD, exclusive)", "type": "string", "description": "Keep reviews before this date." }, "minUsageDays": { "title": "Minimum merchant usage (days)", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Keep reviews where visible app-usage duration is at least this many approximate days.", "default": 0 }, "maxUsageDays": { "title": "Maximum merchant usage (days)", "minimum": 0, "maximum": 36500, "type": "integer", "description": "Optional upper bound for visible merchant app-usage duration." }, "developerReplyMode": { "title": "Developer reply filter", "enum": [ "all", "with_reply", "without_reply" ], "type": "string", "description": "Filter reviews by whether a public developer reply is present.", "default": "all" }, "includeAppDetails": { "title": "Include app store metadata", "type": "boolean", "description": "Fetch each app's public App Store page once and add description, developer, category, icon, pricing and aggregate rating metadata when exposed.", "default": true }, "searchQueries": { "title": "Shopify App Store search keywords", "maxItems": 25, "type": "array", "description": "Discover ranked apps from Shopify App Store search results. Ranking rows are emitted separately from review rows.", "default": [], "items": { "type": "string" } }, "categoryUrls": { "title": "Category URLs", "maxItems": 25, "type": "array", "description": "Shopify App Store category URLs to capture ranked app listings.", "default": [], "items": { "type": "string" } }, "developerUrls": { "title": "Developer / partner URLs", "maxItems": 25, "type": "array", "description": "Shopify App Store partner/developer URLs. Emits a developer summary plus the apps found on the profile.", "default": [], "items": { "type": "string" } }, "maxDiscoveryPages": { "title": "Maximum discovery pages per source", "minimum": 1, "maximum": 20, "type": "integer", "description": "Bound pagination for keyword/category discovery.", "default": 3 }, "maxDiscoveredApps": { "title": "Maximum discovered apps", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap for unique app ranking rows discovered across sources.", "default": 200 }, "scrapeDiscoveredApps": { "title": "Also scrape reviews for discovered apps", "type": "boolean", "description": "When enabled, add discovered app handles to the review queue. Disabled by default so discovery does not unexpectedly increase charged review volume.", "default": 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 } } } } } } } } } }