{ "openapi": "3.0.1", "info": { "title": "App Store & Google Play Review Monitor", "description": "Monitor app reviews in one feed: scrape Apple App Store reviews with version tags, derived sentiment, and new-review alerts. For product, ASO, and competitor tracking, with a hard cost cap. Google Play planned as a follow-on.", "version": "0.0", "x-build-id": "F58TRTdhcB8TlebCa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hamzatrq~app-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hamzatrq-app-review-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/hamzatrq~app-review-monitor/runs": { "post": { "operationId": "runs-sync-hamzatrq-app-review-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/hamzatrq~app-review-monitor/run-sync": { "post": { "operationId": "run-sync-hamzatrq-app-review-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": { "appIds": { "title": "Apple App Store app IDs", "type": "array", "description": "One or more numeric Apple App Store app IDs to monitor reviews for. The numeric id is the number in an App Store URL, e.g. 389801252 in apps.apple.com/app/id389801252. Leave empty for a zero-config demo run on a known public app.", "items": { "type": "string" } }, "googlePlayAppIds": { "title": "Google Play package IDs", "type": "array", "description": "One or more Google Play package IDs (the part after id= in a Play Store URL, e.g. com.spotify.music). Reviews are pulled from the public Play Store reviews endpoint and normalized into the same feed as the App Store reviews. Leave empty to monitor only the App Store.", "items": { "type": "string" } }, "country": { "title": "Storefront country", "type": "string", "description": "Two-letter storefront country code whose reviews to read (e.g. us, gb, de). Applies to both stores. Defaults to us. For multiple storefronts use the countries field instead.", "default": "us" }, "countries": { "title": "Storefront countries (multi)", "type": "array", "description": "Two-letter storefront country codes to read reviews from, one feed per country merged into the output (e.g. us, gb, de). Overrides the single country field when set. Leave empty to use country.", "items": { "type": "string" } }, "minRating": { "title": "Minimum star rating", "type": "integer", "description": "Keep only reviews with at least this star rating (1-5). Combine with maxRating to target a band — e.g. minRating 1 and maxRating 2 to monitor only angry reviews. Leave empty for all ratings." }, "maxRating": { "title": "Maximum star rating", "type": "integer", "description": "Keep only reviews with at most this star rating (1-5). Leave empty for all ratings." }, "keywords": { "title": "Keyword filter", "type": "array", "description": "Keep only reviews whose title or body contains any of these terms (case-insensitive), e.g. crash, refund, login. Leave empty to keep all reviews.", "items": { "type": "string" } }, "maxItems": { "title": "Max reviews per run", "type": "integer", "description": "Upper bound on the number of reviews returned per run (across all apps). The budget is shared round-robin across every requested app and storefront, so each gets coverage. Note: Apple's public feed serves only its most recent reviews per app (~the latest few hundred), so very large maxItems values may return fewer Apple rows. Lower it to keep runs cheap; remove it to fetch all recent reviews Apple serves.", "default": 500 }, "maxCostPerRunUsd": { "title": "Max cost per run (USD)", "type": "integer", "description": "Hard ceiling on spend per run — the run stops before exceeding it, so you are never surprised by the bill.", "default": 5 }, "fullSync": { "title": "Full sync (re-scrape everything)", "type": "boolean", "description": "By default this runs as an incremental monitor: a repeat run emits only NEW or CHANGED records (and bills only for those). Turn this on to re-emit the entire current dataset every run — the one-off scraper / full-export use case.", "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 } } }, "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 } } } } } } } } } }