{ "openapi": "3.0.1", "info": { "title": "Apple App Store Review Alert Monitor", "description": "Monitor Apple App Store reviews and return low-rating or keyword-matched review alerts for product and support teams.", "version": "0.1", "x-build-id": "KD0hwUq6JcHXOqrT4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/careybrown~app-review-alert-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-careybrown-app-review-alert-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/careybrown~app-review-alert-monitor/runs": { "post": { "operationId": "runs-sync-careybrown-app-review-alert-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/careybrown~app-review-alert-monitor/run-sync": { "post": { "operationId": "run-sync-careybrown-app-review-alert-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", "type": "array", "description": "Apple App Store apps to monitor. Use the numeric app ID from an App Store URL.", "items": { "type": "object", "required": [ "appName", "appleId" ], "properties": { "appName": { "title": "App Name", "description": "Readable app name to include in output records.", "type": "string" }, "appleId": { "title": "Apple App ID", "description": "Numeric App Store app ID, such as 310633997.", "type": "string" }, "country": { "title": "Country", "description": "Two-letter App Store country code, such as us, gb, ca, or au.", "type": "string", "default": "us" } } }, "default": [ { "appName": "WhatsApp Messenger", "appleId": "310633997", "country": "us" }, { "appName": "Gmail", "appleId": "422689480", "country": "us" } ] }, "maxReviewsPerApp": { "title": "Maximum Reviews Per App", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum recent matching reviews to return for each app.", "default": 50 }, "minAlertRating": { "title": "Low-Rating Alert Threshold", "minimum": 1, "maximum": 5, "type": "integer", "description": "Reviews at or below this star rating are returned as alerts.", "default": 2 }, "keywords": { "title": "Alert Keywords", "type": "array", "description": "Optional words or phrases that should turn a review into an alert even when the star rating is higher.", "items": { "type": "string" }, "default": [ "crash", "bug", "refund", "support" ] }, "includePositiveReviews": { "title": "Include Non-Alert Reviews", "type": "boolean", "description": "Include recent reviews even when they do not match the rating threshold or keywords.", "default": false }, "includeRawRecord": { "title": "Include Raw Review Record", "type": "boolean", "description": "Include the original Apple RSS review object for debugging.", "default": false } } }, "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 } } } } } } } } } }