{ "openapi": "3.0.1", "info": { "title": "App Store Review Monitor - New & Edited Reviews", "description": "Monitor App Store reviews across countries, detect new and edited reviews from your snapshot, filter ratings and keywords, and get version-country sample rollups. Pay only for delivered reviews.", "version": "0.1", "x-build-id": "zPEMpTPbUbNMCVYlL" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/natstandridge~app-store-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-natstandridge-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/natstandridge~app-store-review-monitor/runs": { "post": { "operationId": "runs-sync-natstandridge-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/natstandridge~app-store-review-monitor/run-sync": { "post": { "operationId": "run-sync-natstandridge-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": "App IDs or official App Store URLs", "minItems": 1, "maxItems": 10, "type": "array", "description": "1-10 numeric IDs or https://apps.apple.com/.../id... links. URLs are parsed for their ID; countries below select the storefronts. At most 20 app-country pairs.", "items": { "type": "string" } }, "countries": { "title": "Countries", "minItems": 1, "maxItems": 5, "type": "array", "description": "1-5 country codes, such as us, gb, de, fr or ca. Each country has its own public review feed. See README for supported codes.", "items": { "type": "string" }, "default": [ "us" ] }, "maxPages": { "title": "Pages per app and country", "minimum": 1, "maximum": 10, "type": "integer", "description": "Apple returns up to 50 reviews per page, up to 10 recent pages. This is a recent window, not full history.", "default": 1 }, "maxResults": { "title": "Maximum delivered reviews", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Overall result cap across all apps and countries. Unfetched or undelivered reviews never advance the snapshot.", "default": 100 }, "minRating": { "title": "Minimum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Include reviews rated at least this many stars, inclusive. Must not exceed maximum rating.", "default": 1 }, "maxRating": { "title": "Maximum rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Include reviews rated at most this many stars, inclusive. Must not be below minimum rating.", "default": 5 }, "keywords": { "title": "Review keywords", "maxItems": 20, "type": "array", "description": "Optional case-insensitive substring matches in title or text; any keyword matches. Up to 20 terms, each 100 characters. Empty means all.", "items": { "type": "string" }, "default": [] }, "versions": { "title": "App versions", "maxItems": 20, "type": "array", "description": "Optional exact version strings, such as 5.2.1. Empty means all. Reviews with an unavailable version do not match an explicit version filter.", "items": { "type": "string" }, "default": [] }, "since": { "title": "Updated since", "type": "string", "description": "Optional inclusive ISO-8601 timestamp with timezone, for example 2026-11-01T00:00:00Z. The bounded recent feed is still scanned; older history is not backfilled." }, "changesOnly": { "title": "Only new or edited reviews", "type": "boolean", "description": "Requires an explicit previousReviews array. An empty array is an intentional empty baseline. Without a baseline, reviews are marked observed.", "default": false }, "previousReviews": { "title": "Previous snapshot", "maxItems": 20000, "type": "array", "description": "Paste OUTPUT.snapshot.previousReviews from the previous run. Each row contains only appId, country, reviewId and contentHash. Maximum 20000 records. This input remains yours; no shared cross-run state is used.", "items": { "type": "object" } }, "maxRunSeconds": { "title": "Work time limit", "minimum": 60, "maximum": 240, "type": "integer", "description": "Includes collection and delivery; collection reserves 25 seconds for persisted results. Platform timeout should be at least 300 seconds.", "default": 180 }, "requestTimeoutSeconds": { "title": "Per-page request timeout", "minimum": 3, "maximum": 30, "type": "integer", "description": "Bounded safe retries, redirects, DNS and robots checks share this hard limit.", "default": 20 } } }, "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 } } } } } } } } } }