{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews & App Feedback Analyzer", "description": "Collect bounded public Apple App Store reviews and turn them into structured feedback, issue clusters, aggregate reports, and cautious release-impact signals.", "version": "0.1", "x-build-id": "ALlhK2qs9wwbxQoYA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/obliging_persimmon_cki~app-store-feedback-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-obliging_persimmon_cki-app-store-feedback-analyzer", "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/obliging_persimmon_cki~app-store-feedback-analyzer/runs": { "post": { "operationId": "runs-sync-obliging_persimmon_cki-app-store-feedback-analyzer", "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/obliging_persimmon_cki~app-store-feedback-analyzer/run-sync": { "post": { "operationId": "run-sync-obliging_persimmon_cki-app-store-feedback-analyzer", "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": { "mode": { "title": "Run mode", "enum": [ "reviews", "releaseImpact" ], "type": "string", "description": "Collect review records or compare feedback around an Apple release.", "default": "reviews" }, "appIds": { "title": "Apple App Store app IDs", "maxItems": 20, "type": "array", "description": "Numeric Apple App Store application IDs.", "items": { "type": "string", "pattern": "^[0-9]+$" } }, "appStoreUrls": { "title": "Apple App Store URLs", "maxItems": 20, "type": "array", "description": "Public App Store URLs containing an /id segment. Explicit app IDs are preserved and take precedence over duplicate URL IDs.", "items": { "type": "string" } }, "country": { "title": "Apple storefront country", "pattern": "^[A-Za-z]{2}$", "type": "string", "description": "Two-letter storefront code used by the public RSS feed.", "default": "US" }, "language": { "title": "Requested feed locale", "pattern": "^[A-Za-z]{2,3}$", "type": "string", "description": "Locale hint sent to the public feed. Apple does not expose a guaranteed reviewer-language field in this feed; unknown language must remain unknown in downstream comparisons.", "default": "en" }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap after pagination and review-ID deduplication.", "default": 50 }, "maxPagesPerApp": { "title": "Maximum feed pages per app", "minimum": 1, "maximum": 10, "type": "integer", "description": "Apple public feed pagination is bounded; the Actor caps this value at 10 pages.", "default": 10 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 120, "type": "integer", "description": "Timeout for each public Apple feed request.", "default": 30 }, "analysis": { "title": "Shared analysis", "type": "object", "description": "Run the shared deterministic feedback-analysis core.", "properties": { "enabled": { "title": "Enabled", "description": "Attach shared analysis to collected reviews.", "type": "boolean", "editor": "checkbox", "default": true }, "outputLanguage": { "title": "Output language", "description": "Language for analysis summaries.", "type": "string", "editor": "select", "enum": [ "english", "original" ], "default": "english" }, "maxAttempts": { "title": "Provider attempts", "description": "Retry budget reserved for a future external provider.", "type": "integer", "editor": "number", "minimum": 1, "maximum": 3, "default": 2 } } }, "aggregation": { "title": "Clustering and reports", "type": "object", "description": "Create platform-level clusters and per-app reports.", "properties": { "enabled": { "title": "Enabled", "description": "Emit clusters and aggregate reports.", "type": "boolean", "editor": "checkbox", "default": true }, "minimumClusterSize": { "title": "Minimum cluster size", "description": "Minimum actionable reviews required for a cluster.", "type": "integer", "editor": "number", "minimum": 1, "maximum": 100, "default": 2 } } }, "release": { "title": "Release metadata", "type": "object", "description": "Release metadata required by releaseImpact mode.", "properties": { "version": { "title": "Version", "description": "Optional released app version for report context.", "type": "string", "editor": "textfield", "default": "" }, "releasedAt": { "title": "Released at", "description": "ISO date-time used as the release boundary.", "type": "string", "editor": "textfield", "default": "" } } }, "daysBefore": { "title": "Days before release", "minimum": 1, "maximum": 365, "type": "integer", "description": "Calendar days collected before the release boundary.", "default": 14 }, "daysAfter": { "title": "Days after release", "minimum": 1, "maximum": 365, "type": "integer", "description": "Calendar days collected after the release boundary.", "default": 14 }, "maxReviewsPerPeriod": { "title": "Maximum reviews per release period", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap applied to each release comparison collection.", "default": 100 }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Enable additional local diagnostic logging.", "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 } } } } } } } } } }