{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Reviews Monitor - New Reviews, Rating & Rank", "description": "For Shopify app developers: reviews of any Shopify App Store app (rating, text, date, store name and country, time using the app, developer reply), app details (rating, review count, pricing plans) and category rank. Monitoring mode returns only new reviews and rating, count or rank changes.", "version": "0.1", "x-build-id": "jECcl5ppXUKK5gouG" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~shopify-app-store-reviews-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-shopify-app-store-reviews-monitor", "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/neverempty~shopify-app-store-reviews-monitor/runs": { "post": { "operationId": "runs-sync-neverempty-shopify-app-store-reviews-monitor", "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/neverempty~shopify-app-store-reviews-monitor/run-sync": { "post": { "operationId": "run-sync-neverempty-shopify-app-store-reviews-monitor", "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": "Apps (Shopify App Store URLs or handles)", "type": "array", "description": "Apps to read: the app URL such as https://apps.shopify.com/judgeme, or just the handle (the last part of that URL), such as judgeme. For each app you get one app row (rating, review count, count per star, pricing plans, developer, categories, launch date) and its newest reviews.", "items": { "type": "string" } }, "categories": { "title": "Categories (Shopify App Store category URLs)", "type": "array", "description": "Optional. Category pages to rank, such as https://apps.shopify.com/categories/marketing-and-conversion-social-trust-product-reviews. You get one row per app in the order the Shopify App Store lists them, with sponsored (ad) placements marked separately and not counted in the rank. Keyword search is not offered: the Shopify App Store disallows automated search requests in its robots.txt.", "items": { "type": "string" } }, "includeReviews": { "title": "Return reviews", "type": "boolean", "description": "Turn off to get only the app row (rating, review count, pricing) for each app.", "default": true }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Newest reviews first, 10 per page read. In monitoring mode this is the most new reviews returned per app per run; the rest come with the next run.", "default": 50 }, "maxCategoryPages": { "title": "Category pages to read", "minimum": 1, "maximum": 50, "type": "integer", "description": "Each category page lists about 20 apps plus up to 4 sponsored placements. 2 pages gives the top 40.", "default": 2 }, "monitoringMode": { "title": "Monitoring mode (only what is new or changed)", "type": "boolean", "description": "The first run returns the current state and remembers it. Every later run with the same apps and categories returns only reviews added since then, an app row only when its rating or review count changed (with the previous values), and category rows only for apps whose rank changed. A target with nothing new returns no rows and costs one small check fee.", "default": false }, "resetMonitoringState": { "title": "Forget what was seen before", "type": "boolean", "description": "Clears the remembered state for the apps and categories in this input before the run, so the run behaves like a first run for them.", "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 } } } } } } } } } }