{ "openapi": "3.0.1", "info": { "title": "App Review Intelligence Scraper", "description": "Scrape public Apple App Store and Google Play reviews, then generate statistics and DeepSeek AI product intelligence reports.", "version": "0.1", "x-build-id": "C6jVJPrfY40XZaoxs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/winterly_fly~app-review-intelligence-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-winterly_fly-app-review-intelligence-scraper", "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/winterly_fly~app-review-intelligence-scraper/runs": { "post": { "operationId": "runs-sync-winterly_fly-app-review-intelligence-scraper", "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/winterly_fly~app-review-intelligence-scraper/run-sync": { "post": { "operationId": "run-sync-winterly_fly-app-review-intelligence-scraper", "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", "maxItems": 25, "type": "array", "description": "Apps to scrape. Use platform auto/apple/google plus url, appId, or packageName. App Store URLs, Apple numeric IDs, Google Play URLs, and package names are supported." }, "appUrl": { "title": "Single App Store or Google Play URL", "maxLength": 2048, "type": "string", "description": "Optional convenience field for one App Store or Google Play URL. You can use this instead of the Apps JSON field for a single app." }, "appUrls": { "title": "Multiple App Store or Google Play URLs", "maxItems": 25, "type": "array", "description": "Optional convenience field for multiple App Store or Google Play URLs.", "items": { "type": "string", "maxLength": 2048 } }, "appleAppId": { "title": "Single Apple App ID", "maxLength": 32, "type": "string", "description": "Optional numeric Apple App Store ID, e.g. 570060128." }, "appleAppIds": { "title": "Multiple Apple App IDs", "maxItems": 25, "type": "array", "description": "Optional list of numeric Apple App Store IDs.", "items": { "type": "string", "maxLength": 32 } }, "googlePlayUrl": { "title": "Single Google Play URL", "maxLength": 2048, "type": "string", "description": "Optional Google Play app URL. You can use this instead of the Apps JSON field for a single Android app." }, "googlePlayUrls": { "title": "Multiple Google Play URLs", "maxItems": 25, "type": "array", "description": "Optional list of Google Play app URLs.", "items": { "type": "string", "maxLength": 2048 } }, "googlePlayPackageName": { "title": "Single Google Play package name", "maxLength": 100, "type": "string", "description": "Optional Android package name, e.g. com.duolingo." }, "googlePackageNames": { "title": "Multiple Google Play package names", "maxItems": 25, "type": "array", "description": "Optional list of Android package names.", "items": { "type": "string", "maxLength": 100 } }, "countries": { "title": "Countries / regions", "maxItems": 25, "type": "array", "description": "Two-letter country or region codes. The Actor tries each country for each app.", "items": { "type": "string", "maxLength": 10 } }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code. Google Play uses it directly. Apple web reviews use it as part of the requested locale when supported.", "default": "en" }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of output reviews per app after filters and deduplication.", "default": 100 }, "maxRawReviewsPerApp": { "title": "Max raw reviews per app (optional)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum raw reviews to fetch before filters. Leave empty for automatic sizing: target count for normal runs, 5x target count for strict filters." }, "sort": { "title": "Review sort", "enum": [ "recent", "helpful", "rating" ], "type": "string", "description": "Review ordering requested from the platform when supported.", "default": "recent" }, "startDate": { "title": "Start date", "type": "string", "description": "Optional inclusive start date in YYYY-MM-DD format." }, "endDate": { "title": "End date", "type": "string", "description": "Optional inclusive end date in YYYY-MM-DD format." }, "sinceDays": { "title": "Since days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Optional shortcut for recent reviews. For example, 30 keeps reviews from the last 30 days unless startDate is also set." }, "ratings": { "title": "Star ratings", "maxItems": 5, "type": "array", "description": "Optional list of star ratings to keep, e.g. [1,2]. Empty means all ratings.", "items": { "type": "integer", "minimum": 1, "maximum": 5 } }, "onlyNegative": { "title": "Only negative reviews", "type": "boolean", "description": "Keep only negative reviews. Defaults to 1-2 star reviews unless negativeRatings is changed.", "default": false }, "negativeRatings": { "title": "Negative ratings", "maxItems": 5, "type": "array", "description": "Ratings treated as negative when onlyNegative is enabled and in the statistics.", "items": { "type": "integer", "minimum": 1, "maximum": 5 } }, "unansweredOnly": { "title": "Unanswered reviews only", "type": "boolean", "description": "Keep only reviews that do not have a captured developer reply.", "default": false }, "minHelpfulCount": { "title": "Minimum helpful count", "minimum": 0, "type": "integer", "description": "Keep only reviews with at least this many helpful/upvote counts when the platform provides that field.", "default": 0 }, "keywords": { "title": "Keywords", "maxItems": 50, "type": "array", "description": "Optional keyword filters. Reviews are matched against title and text.", "items": { "type": "string", "maxLength": 100 } }, "keywordMode": { "title": "Keyword mode", "enum": [ "any", "all" ], "type": "string", "description": "Match any keyword or all keywords.", "default": "any" }, "deduplicate": { "title": "Deduplicate reviews", "type": "boolean", "description": "Remove duplicate review IDs and fallback duplicate text/date/rating combinations.", "default": true }, "enableAiAnalysis": { "title": "Enable DeepSeek AI analysis", "type": "boolean", "description": "Generate the AI product intelligence report. If DeepSeek fails, scraping and basic statistics still succeed.", "default": true }, "aiReportLanguage": { "title": "AI report language", "type": "string", "description": "Language for AI-generated report sections.", "default": "English" }, "reportTopReviewCount": { "title": "Top reviews in report", "minimum": 0, "maximum": 100, "type": "integer", "description": "Number of highest-priority reviews to show in the Markdown/HTML report.", "default": 10 }, "aiMaxReviews": { "title": "Max reviews sent to AI", "minimum": 10, "maximum": 1000, "type": "integer", "description": "Caps review samples sent to DeepSeek to control token cost.", "default": 300 }, "aiRequestTimeoutMs": { "title": "AI request timeout in ms", "minimum": 10000, "maximum": 300000, "type": "integer", "description": "Timeout for the DeepSeek analysis request. Increase this if larger reports need more generation time.", "default": 120000 }, "requestDelayMs": { "title": "Request delay in ms", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between platform review page requests.", "default": 500 }, "requestTimeoutMs": { "title": "Request timeout in ms", "minimum": 5000, "maximum": 120000, "type": "integer", "description": "Hard timeout for individual platform requests.", "default": 30000 } } }, "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 } } } } } } } } } }