{ "openapi": "3.0.1", "info": { "title": "App Store Review Monitor — New iOS Reviews, All Countries", "description": "Monitor Apple App Store reviews for your apps and competitors across all 175 storefronts. Only-new alert mode, star-rating and keyword filters, per-app rating summary. Official Apple feeds, no login, no proxies.", "version": "1.0", "x-build-id": "1fUHUYiKITSx6hhQ3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gazidev~app-store-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gazidev-app-store-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/gazidev~app-store-review-monitor/runs": { "post": { "operationId": "runs-sync-gazidev-app-store-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/gazidev~app-store-review-monitor/run-sync": { "post": { "operationId": "run-sync-gazidev-app-store-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", "required": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "App Store URLs (https://apps.apple.com/us/app/duolingo/id570060128), numeric app IDs (570060128) or app names (\"Duolingo\" — the top search result is used). Add your own apps and your competitors'.", "items": { "type": "string" } }, "countries": { "title": "Countries (App Store storefronts)", "type": "array", "description": "Two-letter codes, e.g. us, gb, de, tr, jp. Use \"TOP30\" for the 30 biggest markets or \"ALL\" for all 175 storefronts. Reviews are separate per storefront, so more countries = more reviews. The first country is also used for app metadata and name search.", "default": [ "us" ], "items": { "type": "string" } }, "onlyNewSinceLastRun": { "title": "Only new reviews since last run (alert mode)", "type": "boolean", "description": "Remember delivered reviews and output only new ones on each run. Schedule the Actor hourly/daily and pipe results to Slack, email, Sheets or your helpdesk. You pay only for new reviews.", "default": true }, "stateKey": { "title": "Monitor name", "type": "string", "description": "Name of the 'already delivered' memory. Use different names for independent monitors (e.g. one per client). Default: \"default\".", "default": "default" }, "ratings": { "title": "Star ratings to include", "type": "array", "description": "Keep only these star ratings. E.g. [1, 2] for a negative-review alert. Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "★ 1", "★★ 2", "★★★ 3", "★★★★ 4", "★★★★★ 5" ] }, "default": [] }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Keep only reviews whose title or text contains ANY of these words (case/accent-insensitive; trailing * = prefix, e.g. \"crash*\"). Great for bug, pricing or feature-request tracking.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Drop reviews containing any of these words.", "default": [], "items": { "type": "string" } }, "daysBack": { "title": "Only reviews from the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "0 = no date limit (Apple's feed exposes the latest ~500 reviews per app per country).", "default": 0 }, "sortBy": { "title": "Sort / feed", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "mostrecent is best for monitoring; mosthelpful returns the most up-voted reviews.", "default": "mostrecent" }, "maxReviewsPerCountry": { "title": "Max reviews per app per country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Apple's feed provides up to 500 per app per storefront.", "default": 500 }, "includeAppSummary": { "title": "Add per-app summary row", "type": "boolean", "description": "Adds one row per app with the current store rating, rating count, version, and stats of the scanned and new reviews (e.g. number of new 1–2★ reviews). Charged as a separate small event.", "default": true }, "maxItems": { "title": "Max reviews per run", "minimum": 1, "type": "integer", "description": "Hard cap on review rows (and cost) per run. Undelivered new reviews are kept for the next run.", "default": 10000 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 20, "type": "integer", "description": "Advanced. Keep it modest to stay friendly with Apple's servers.", "default": 8 } } }, "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 } } } } } } } } } }