{ "openapi": "3.0.1", "info": { "title": "Apple App Store Review & Competitor Intelligence", "description": "Monitor recent public Apple App Store reviews across apps and storefronts, detect complaints, competitor mentions, switching signals, and newly observed reviews using Apple's public customer-review feeds.", "version": "0.1", "x-build-id": "5y7W92yxXxEZa7WuV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datahunter_labs~apple-app-store-review-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datahunter_labs-apple-app-store-review-intelligence", "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/datahunter_labs~apple-app-store-review-intelligence/runs": { "post": { "operationId": "runs-sync-datahunter_labs-apple-app-store-review-intelligence", "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/datahunter_labs~apple-app-store-review-intelligence/run-sync": { "post": { "operationId": "run-sync-datahunter_labs-apple-app-store-review-intelligence", "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", "countries" ], "properties": { "apps": { "title": "App Store apps", "minItems": 1, "maxItems": 30, "type": "array", "description": "Numeric Apple App Store IDs or full App Store URLs. Example: 389801252 or https://apps.apple.com/us/app/instagram/id389801252", "items": { "type": "string" }, "default": [ "389801252" ] }, "countries": { "title": "App Store storefront countries", "minItems": 1, "maxItems": 20, "type": "array", "description": "Two-letter App Store storefront codes. Reviews are storefront-specific.", "items": { "type": "string" }, "default": [ "us" ] }, "maxReviewsPerApp": { "title": "Maximum reviews per app and country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum recent written reviews returned for each app/storefront pair. Apple's public feed exposes a recent window rather than full history.", "default": 50 }, "sort": { "title": "Review sort", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Apple public feed sort order.", "default": "mostrecent" }, "ratings": { "title": "Rating filter", "uniqueItems": true, "type": "array", "description": "Optional star filter. Empty means all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "competitorNames": { "title": "Competitor names to detect", "type": "array", "description": "Optional app or brand names to detect inside review text and switching language.", "items": { "type": "string" }, "default": [] }, "monitorChanges": { "title": "Monitor new reviews", "type": "boolean", "description": "Persist review IDs per app/storefront/filter so later runs can identify newly observed reviews.", "default": true }, "onlyNewReviews": { "title": "Emit only new reviews after baseline", "type": "boolean", "description": "After a monitoring baseline exists, emit only newly observed reviews plus the app summary.", "default": false }, "includeReviewerName": { "title": "Include public reviewer display name", "type": "boolean", "description": "Off by default. Enable only if your workflow needs the public reviewer display name.", "default": false }, "cacheTtlMinutes": { "title": "Cache TTL (minutes)", "minimum": 1, "maximum": 10080, "type": "integer", "description": "Used by non-monitoring runs to avoid unnecessary Apple requests.", "default": 120 }, "forceRefresh": { "title": "Force refresh", "type": "boolean", "description": "Ignore a valid cache entry on non-monitoring runs.", "default": false }, "maxRequestsPerRun": { "title": "Request budget", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on Apple feed HTTP requests made during a run, including retries and format fallbacks.", "default": 60 }, "timeoutSeconds": { "title": "HTTP timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Timeout per Apple feed request.", "default": 20 }, "requestDelaySeconds": { "title": "Delay between app/storefront pairs (seconds)", "minimum": 0, "maximum": 10, "type": "integer", "description": "Optional polite delay between app/storefront pairs.", "default": 0 }, "directFirst": { "title": "Try Apple directly first", "type": "boolean", "description": "Use Apple's public feed directly first to minimize proxy cost. On confirmed blocking or transient network errors, retry through the configured proxy with bounded session rotation.", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify/custom proxy fallback. It is not used when the direct Apple feed succeeds.", "default": { "useApifyProxy": true } }, "maxProxyRotations": { "title": "Maximum proxy rotations", "minimum": 0, "maximum": 5, "type": "integer", "description": "Bounded retries after confirmed blocks, HTTP 408/5xx/520-524, or network timeouts.", "default": 1 }, "proxyBackoffSeconds": { "title": "Proxy retry backoff (seconds)", "minimum": 0, "maximum": 15, "type": "integer", "description": "Base delay before retrying on a fresh proxy route. Uses bounded linear backoff.", "default": 1 } } }, "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 } } } } } } } } } }