{ "openapi": "3.0.1", "info": { "title": "Unofficial Shopify App Store Reviews Monitor: Review Alerts", "description": "Shopify app review monitoring and review alerts: newest App Store reviews for your app or competitors (rating, text, store, country, developer reply). Filter 1-2 star or unanswered reviews, date cut-off, new-only daily runs. Unofficial.", "version": "1.0", "x-build-id": "n2LZ5iZD2tSnBJSRL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tali-works~shopify-app-store-reviews-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tali-works-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/tali-works~shopify-app-store-reviews-monitor/runs": { "post": { "operationId": "runs-sync-tali-works-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/tali-works~shopify-app-store-reviews-monitor/run-sync": { "post": { "operationId": "run-sync-tali-works-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 (handles or URLs)", "type": "array", "description": "Shopify App Store apps to check: the handle from the URL (e.g. 'judgeme' from https://apps.shopify.com/judgeme) or the full app/reviews URL. Up to 50 apps per run.", "items": { "type": "string" } }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only reviews with these ratings (uses the App Store's own rating filter). Leave empty for all ratings. Tip: 1 + 2 for a complaint queue.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "onlyUnanswered": { "title": "Only reviews without a developer reply", "type": "boolean", "description": "Skip reviews the developer has already replied to - a to-do list for your support team.", "default": false }, "reviewsSince": { "title": "Reviews since", "type": "string", "description": "Optional cut-off: YYYY-MM-DD or a relative value like '30 days', '2 weeks', '3 months'. Reviews are read newest first and reading stops once older reviews are reached. Dates are the review dates shown on the App Store." }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 3000, "type": "integer", "description": "Cap per app per run (10 reviews per App Store page, read at about 1 page per second).", "default": 50 }, "includeAppSummary": { "title": "Include an app rating summary row", "type": "boolean", "description": "One extra row per app with app name, developer, average rating, total reviews and % of 1-5 star ratings (charged as one row). In new-only mode it is only written when the app has new reviews.", "default": true }, "onlyNew": { "title": "New-only monitor mode", "type": "boolean", "description": "Remember reviews already output and return only unseen ones on later runs (first run = baseline, output once). Pair with an Apify schedule for daily checks.", "default": false }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Optional name for the new-only memory, so you can change other settings and keep the same memory (e.g. 'my-apps'). Without it, the memory is tied to the apps, ratings and unanswered settings." } } }, "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 } } } } } } } } } }