{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Scraper: Apps, Reviews & Monitoring", "description": "Scrapes apps.shopify.com: app details, pricing plans, exact star counts, reviews past the 10,000 limit with developer replies, category and search rankings with ads, change monitoring between runs, a 0-100 score and an HTML report.", "version": "0.1", "x-build-id": "dzGQm4JbDS1jajEjP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solalab_digital~shopify-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solalab_digital-shopify-app-store-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/solalab_digital~shopify-app-store-scraper/runs": { "post": { "operationId": "runs-sync-solalab_digital-shopify-app-store-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/solalab_digital~shopify-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-solalab_digital-shopify-app-store-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": { "appHandles": { "title": "Apps", "type": "array", "description": "App handles (\"judgeme\") or full app URLs (https://apps.shopify.com/judgeme).", "items": { "type": "string" } }, "categoryHandles": { "title": "Categories", "type": "array", "description": "Category handles or URLs (https://apps.shopify.com/categories/marketing-and-conversion-social-trust-product-reviews). Saves one ranking row per app with its position, page and Ad flag.", "items": { "type": "string" } }, "developerHandles": { "title": "Developers", "type": "array", "description": "Developer (partner) handles or URLs (https://apps.shopify.com/partners/judge-me). Collects all apps of the developer.", "items": { "type": "string" } }, "searchQueries": { "title": "Search keywords", "type": "array", "description": "Keywords searched in the App Store; positions and ads are saved as ranking rows. Note: the store's robots.txt asks crawlers not to fetch search pages, use at your own discretion.", "items": { "type": "string" } }, "allAppsFromSitemap": { "title": "Whole catalog from sitemap", "type": "boolean", "description": "Take every app listed in the store sitemap (about 27,600). Combine with Max apps and the filters below to control cost.", "default": false }, "sitemapLastmodSince": { "title": "Only apps updated since", "type": "string", "description": "With the sitemap source: only apps whose sitemap lastmod is on or after this date. Handy for incremental runs." }, "scrapeAppDetails": { "title": "Open each app found in categories, search and developers", "type": "boolean", "description": "On: every app found in a listing is opened and saved with full details. Off: only the cheap ranking rows are saved (apps from the Apps field are always opened).", "default": true }, "maxApps": { "title": "Max apps", "minimum": 0, "type": "integer", "description": "Maximum number of app rows per run. 0 = no limit.", "default": 100 }, "maxCategoryPages": { "title": "Max category pages", "minimum": 0, "type": "integer", "description": "Pages per category (about 20 apps + ads per page). 0 = all pages.", "default": 5 }, "maxSearchPages": { "title": "Max search pages", "minimum": 0, "type": "integer", "description": "Pages per keyword (about 24 apps + ads per page). 0 = all pages.", "default": 3 }, "maxDeveloperPages": { "title": "Max developer pages", "minimum": 0, "type": "integer", "description": "Pages per developer. 0 = all pages.", "default": 10 }, "minRating": { "title": "Min rating", "pattern": "^$|^[0-5](\\.[0-9])?$", "type": "string", "description": "Keep apps rated at least this (for example 4.5). Leave empty for no limit." }, "minReviews": { "title": "Min reviews", "minimum": 0, "type": "integer", "description": "Keep apps with at least this many reviews." }, "maxReviews": { "title": "Max reviews", "minimum": 0, "type": "integer", "description": "Keep apps with at most this many reviews (find small or new competitors)." }, "pricingFilter": { "title": "Pricing", "enum": [ "any", "free", "freePlan", "freeTrial", "paidOnly" ], "type": "string", "description": "Filter by pricing model.", "default": "any" }, "builtForShopifyOnly": { "title": "Built for Shopify only", "type": "boolean", "description": "Keep only apps with the Built for Shopify badge.", "default": false }, "requireCategories": { "title": "Must be in category", "type": "array", "description": "Keep apps listed in at least one of these categories (category handle or name, for example \"SEO\").", "items": { "type": "string" } }, "excludeAds": { "title": "Skip ads", "type": "boolean", "description": "Ignore paid (Ad) placements in category and search results.", "default": false }, "includeReviews": { "title": "Collect reviews", "type": "boolean", "description": "Collect reviews for every app that passes the filters.", "default": false }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 0, "type": "integer", "description": "0 = all reviews (switches to newest-first, which goes past the store's 10,000-review limit).", "default": 100 }, "reviewRatings": { "title": "Only these star ratings", "type": "array", "description": "For example only 1 and 2 stars to study complaints. Empty = all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Only reviews on or after this date; collection stops at the first older review (uses newest-first order)." }, "reviewSort": { "title": "Review order", "enum": [ "newest", "relevance" ], "type": "string", "description": "Most relevant stops at 10,000 reviews; newest is used automatically when you need more or set a date.", "default": "newest" }, "reviewsOutput": { "title": "Review output", "enum": [ "rows", "embedded" ], "type": "string", "description": "Separate rows (one dataset row per review) or embedded (up to 200 reviews inside the app row, one row per app).", "default": "rows" }, "monitorId": { "title": "Monitor ID", "pattern": "^$|^[A-Za-z0-9-]{1,40}$", "type": "string", "description": "Any name (letters, digits, dashes). Each app row gets a delta (rating, reviews, star counts, pricing, Built for Shopify, positions) and apps that left the results are listed in the report." }, "generateReport": { "title": "HTML report", "type": "boolean", "description": "Save an HTML report (REPORT in the key-value store): rating vs reviews map, app table, pricing, Built for Shopify and ad share, changes.", "default": true }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 50, "type": "integer", "description": "Lowered automatically when the store starts rate limiting.", "default": 10 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed for small runs. For whole-catalog runs datacenter proxy is enough. If the proxy fails, the run continues without it.", "default": { "useApifyProxy": false } }, "locale": { "title": "Store language", "type": "string", "description": "Language code of the store pages, for example en, de, fr, es, ja.", "default": "en" } } }, "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 } } } } } } } } } }