{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Scraper - Ranks, Pricing & Reviews", "description": "Track Shopify App Store category ranks, pricing plans, ratings and reviews. Tags 1-2 star complaints by theme and reports rank moves, new apps and price changes since your last run.", "version": "1.0", "x-build-id": "aykB8g8fnkyC2fVEt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/benthepythondev~shopify-app-store-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-benthepythondev-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/benthepythondev~shopify-app-store-scraper/runs": { "post": { "operationId": "runs-sync-benthepythondev-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/benthepythondev~shopify-app-store-scraper/run-sync": { "post": { "operationId": "run-sync-benthepythondev-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": { "categories": { "title": "Categories", "type": "array", "description": "Shopify App Store category slugs or URLs to rank, e.g. 'marketing-and-conversion-social-trust-product-reviews' or https://apps.shopify.com/categories/store-design-site-optimization-seo. Subcategories give the full ranked list; top-level categories give the curated picks. Use [] to read only appUrls.", "default": [ "marketing-and-conversion-social-trust-product-reviews" ], "items": { "type": "string" } }, "appUrls": { "title": "App URLs or handles", "type": "array", "description": "Specific apps to read, as URLs or handles, e.g. https://apps.shopify.com/judgeme or 'klaviyo-email-marketing'. Read in addition to the categories.", "default": [], "items": { "type": "string" } }, "maxApps": { "title": "Max apps per category", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many ranked apps to read from each category, e.g. 24 (one page) or 100. Each app is one billed result.", "default": 24 }, "includeDetails": { "title": "Include app details and pricing plans", "type": "boolean", "description": "Open every app page for pricing plans (name, price, interval, trial days, features), rating distribution, developer, launch date, languages, works-with and categories. Off: only the ranked card data.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Also read each app's newest reviews, tag 1-2 star reviews with complaint themes (billing, support, bugs...) and add a per-app theme count. Each review is one billed result.", "default": false }, "maxReviews": { "title": "Max reviews per app", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many newest reviews to read per app when reviews are on, e.g. 20 or 200 (10 reviews per page).", "default": 20 }, "reviewStars": { "title": "Only these star ratings", "type": "array", "description": "Read only reviews with these ratings, e.g. ['1','2'] for complaints only. Empty list reads all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "trackChanges": { "title": "Report changes since the last run", "type": "boolean", "description": "Save each category's ranks, ratings, review counts and pricing in a named key-value store and output free 'change' rows on the next run: rank moves, new entrants, dropped apps, rating and review-count deltas, pricing plan changes.", "default": true }, "stateStoreName": { "title": "Change-tracking store name", "type": "string", "description": "Name of the key-value store that keeps the last snapshot, e.g. 'shopify-app-store-tracker'. Use a different name per project to keep separate histories.", "default": "shopify-app-store-tracker" } } }, "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 } } } } } } } } } }