{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Monitor (iOS, Multi-Country)", "description": "Unofficial; not affiliated with Apple. Monitor Apple App Store reviews for many apps and countries via Apple's public reviews feed. Star filter, rating summary per feed, only-new and edited reviews for scheduled runs.", "version": "0.1", "x-build-id": "fqztzNcxOQT8Th2Sw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brightish_ascent~app-store-reviews-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brightish_ascent-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/brightish_ascent~app-store-reviews-monitor/runs": { "post": { "operationId": "runs-sync-brightish_ascent-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/brightish_ascent~app-store-reviews-monitor/run-sync": { "post": { "operationId": "run-sync-brightish_ascent-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", "required": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "App Store app IDs (e.g. 389801252) or apps.apple.com app URLs.", "items": { "type": "string" } }, "countries": { "title": "Countries (storefronts)", "type": "array", "description": "2-letter App Store storefront codes, e.g. \"us\", \"gb\", \"de\". Default [\"us\"]. apps x countries max 40 per run.", "items": { "type": "string" } }, "maxPagesPerFeed": { "title": "Max pages per app/country", "minimum": 1, "maximum": 10, "type": "integer", "description": "Apple serves up to 10 pages of 50 most-recent reviews (500) per app and country. Lower this for faster, cheaper runs.", "default": 10 }, "ratings": { "title": "Star ratings to keep", "type": "array", "description": "Keep only reviews with these star ratings (e.g. 1 and 2 for complaint monitoring). Empty = all. Feed statistics in OUTPUT always use every review read.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ] } }, "includeReviewerName": { "title": "Include reviewer nickname", "type": "boolean", "description": "Add the reviewer's public App Store nickname to each row. Off by default (data minimisation).", "default": false }, "onlyNewSinceLastRun": { "title": "Only new since last run (monitor mode)", "type": "boolean", "description": "Remember delivered reviews per input set in a named key-value store in your account. Later runs return only new reviews and edited reviews (rating, title, text or app version changed, with previous values). First run = baseline (all reviews read, as new).", "default": false }, "maxItems": { "title": "Max rows", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum dataset rows per run (each row is one charged event). In monitor mode, rows over the limit are delivered on the next run.", "default": 500 }, "outputFormat": { "title": "Output format", "enum": [ "full", "compact" ], "type": "string", "description": "full = all fields; compact = reviewKey, updateType, appName, country, rating, title, content, appVersion, updatedAt, previous, changeHash.", "default": "full" } } }, "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 } } } } } } } } } }