{ "openapi": "3.0.1", "info": { "title": "App Review Change Monitor", "description": "Monitor public App Store review feeds for new reviews, rating drops, and competitor review digests.", "version": "0.1", "x-build-id": "UFsxWHk2bHkTRRQO4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/silicon1235~app-review-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-silicon1235-app-review-change-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/silicon1235~app-review-change-monitor/runs": { "post": { "operationId": "runs-sync-silicon1235-app-review-change-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/silicon1235~app-review-change-monitor/run-sync": { "post": { "operationId": "run-sync-silicon1235-app-review-change-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 Store apps", "type": "array", "description": "Apps to monitor. Use Apple App Store app IDs and optional labels." }, "country": { "title": "Default country", "type": "string", "description": "Default two-letter App Store country code used when an app does not specify one.", "default": "ca" }, "fallbackCountries": { "title": "Fallback countries", "type": "array", "description": "Optional country codes to try when an app's primary App Store review feed is empty.", "default": [ "ca", "au", "us", "gb" ], "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum recent reviews to read from each public App Store RSS feed. Values above 100 are capped by the Actor to protect scheduled-run cost.", "default": 50 }, "maxApps": { "title": "Maximum apps per run", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum app entries to process in one run. Keep this low for the first remote test and scheduled runs.", "default": 5 }, "previousReviewIds": { "title": "Previous review IDs", "type": "array", "description": "Optional review IDs from a previous run. Reviews not in this list are marked NEW.", "default": [], "items": { "type": "string" } }, "lowRatingThreshold": { "title": "Low rating threshold", "minimum": 1, "maximum": 5, "type": "integer", "description": "Reviews at or below this star rating are flagged as low-rating alerts.", "default": 2 }, "alertKeywords": { "title": "Alert keywords", "type": "array", "description": "Keywords that mark a new review as an alert even when the star rating is not low.", "default": [ "bug", "crash", "broken", "login", "refund", "subscription", "charged", "privacy" ], "items": { "type": "string" } }, "snapshotKey": { "title": "Snapshot key", "type": "string", "description": "Key-value store record used to load and save review IDs for scheduled monitoring.", "default": "APP_REVIEW_SNAPSHOT" }, "saveSnapshot": { "title": "Save review snapshot", "type": "boolean", "description": "Save current review IDs to the key-value store so the next run can detect new reviews automatically.", "default": true } } }, "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 } } } } } } } } } }