{ "openapi": "3.0.1", "info": { "title": "Apple App Store Review Monitor", "description": "Monitor recent Apple App Store reviews by app and country. Filter ratings and keywords, compare review changes, and export review text, app versions and source links.", "version": "1.0", "x-build-id": "Vzbtg5fniz8Hlcnxf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maydit~apple-app-store-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maydit-apple-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/maydit~apple-app-store-review-monitor/runs": { "post": { "operationId": "runs-sync-maydit-apple-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/maydit~apple-app-store-review-monitor/run-sync": { "post": { "operationId": "run-sync-maydit-apple-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", "properties": { "apps": { "title": "Apps and storefronts", "type": "array", "description": "App Store numeric IDs and two-letter country codes. Different storefronts have different reviews. If omitted or empty, the code uses Duolingo US (570060128).", "items": { "type": "object", "properties": { "appId": { "title": "App Store app ID", "type": "string", "editor": "textfield", "description": "Numeric ID from the app's Apple App Store URL, for example 570060128.", "pattern": "^[0-9]+$" }, "country": { "title": "Storefront country code", "type": "string", "editor": "textfield", "description": "Two-letter storefront code, for example us or gb. This does not identify a reviewer's location.", "pattern": "^[a-zA-Z]{2}$" } }, "required": [ "appId", "country" ], "additionalProperties": false } }, "maxResults": { "title": "Maximum saved review observations", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Run-wide cap on real saved rows after filters. Limits are ceilings, not guaranteed result counts.", "default": 5 }, "maxPagesPerApp": { "title": "Maximum feed pages per app", "minimum": 1, "maximum": 10, "type": "integer", "description": "Read at most this many recent-feed pages for each app and storefront. Public feeds are a limited recent window, not a complete archive.", "default": 1 }, "maxRating": { "title": "Maximum review rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Keep reviews with a rating at or below this value. Use 2 to focus on one- and two-star feedback.", "default": 5 }, "keywords": { "title": "Keywords in review title or text", "type": "array", "description": "Optional literal, case-insensitive terms. A review must match any one term in its title or body. No regular expressions or semantic sentiment analysis.", "items": { "type": "string" }, "default": [] }, "comparePrevious": { "title": "Compare with saved observations", "type": "boolean", "description": "Compare the same app, storefront and review ID with saved history. First-seen means new to this snapshot, not necessarily newly published.", "default": false }, "onlyChanges": { "title": "Save only first-seen or changed reviews", "type": "boolean", "description": "Implies comparison. Later unchanged runs may save zero rows. Reviews missing from the feed are not reported as deleted.", "default": false }, "snapshotName": { "title": "Snapshot name", "pattern": "^[A-Za-z0-9_-]{1,80}$", "minLength": 1, "maxLength": 80, "type": "string", "description": "Letters, digits, underscores and hyphens only. Reuse this name for scheduled comparisons; use one sequential writer per snapshot.", "default": "default" }, "maxRunSeconds": { "title": "Run time budget in seconds", "minimum": 30, "maximum": 900, "type": "integer", "description": "Maximum work budget. Source delays, platform timeout and output limits can end the run earlier.", "default": 240 } } }, "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 } } } } } } } } } }