{ "openapi": "3.0.1", "info": { "title": "Reviewbot Universal Review Scraper", "description": "Extract app reviews from Google Play, Apple App Store, and Microsoft Store using a single actor. Supports filters like ratings, dates, country, and webhooks. Ideal for unified review monitoring, analytics, and cross-platform insights.", "version": "2.0", "x-build-id": "cfNDLaCHxAoqgyXIN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reviewbot~universal-review-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reviewbot-universal-review-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/reviewbot~universal-review-scraper/runs": { "post": { "operationId": "runs-sync-reviewbot-universal-review-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/reviewbot~universal-review-scraper/run-sync": { "post": { "operationId": "run-sync-reviewbot-universal-review-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", "required": [ "store", "appId" ], "properties": { "store": { "title": "Store Platform", "enum": [ "google", "apple", "microsoft", "tencent" ], "type": "string", "description": "Choose which app store to scrape", "default": "google" }, "appId": { "title": "App ID / Package Name", "type": "string", "description": "App identifier - Format varies by store: Google/Tencent: package name (e.g., com.whatsapp), Apple: numeric ID (e.g., 310633997), Microsoft: app ID (e.g., 9nksqgp7f2nh)", "default": "com.whatsapp" }, "limit": { "title": "Review Limit", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of reviews to scrape (default: 100, max: 1000). Works with: [Google, Apple, Microsoft, Tencent]", "default": 100 }, "country": { "title": "Country / Market", "enum": [ "auto", "us", "gb", "ca", "au", "de", "fr", "es", "it", "nl", "jp", "kr", "sg", "hk", "br", "mx", "in", "se", "no", "dk", "fi", "pl", "cz", "ru", "tr", "il", "ae", "sa", "za", "eg" ], "type": "string", "description": "Country/market code for store region. Use 'auto' for intelligent detection. Works with: [Google, Apple, Microsoft]. For Microsoft, this sets the market (e.g., US, GB). For Tencent, this field is ignored (China only).", "default": "auto" }, "language": { "title": "Language / Locale", "enum": [ "en", "es", "fr", "de", "it", "pt", "ja", "ko", "zh" ], "type": "string", "description": "Language code for reviews and interface. Works with: [Google]. For Microsoft, locale is auto-detected from country. For Tencent, reviews are in Chinese (use translateTo for English).", "default": "en" }, "translateTo": { "title": "Translate Reviews To", "enum": [ "en", "es", "fr", "de", "it", "pt", "ja", "ko", "ru", "ar", "hi" ], "type": "string", "description": "Translate reviews to this language. Works with: [Tencent]. Translates Chinese reviews to your target language (default: English).", "default": "en" }, "startDate": { "title": "Start Date", "type": "string", "description": "Filter reviews from this date (ISO format: YYYY-MM-DD). Works with: [Google, Apple, Microsoft, Tencent]" }, "endDate": { "title": "End Date", "type": "string", "description": "Filter reviews until this date (ISO format: YYYY-MM-DD). Works with: [Google, Apple, Microsoft, Tencent]" }, "ratings": { "title": "Rating Filter", "type": "array", "description": "Include only these star ratings (1-5). Works with: [Google, Apple, Microsoft, Tencent]", "items": { "type": "integer", "minimum": 1, "maximum": 5 }, "default": [ 1, 2, 3, 4, 5 ] }, "webhookUrl": { "title": "Webhook URL (Optional)", "type": "string", "description": "Your webhook endpoint to receive review data in real-time. Works with: [Google, Apple, Microsoft, Tencent]" }, "webhookApiKey": { "title": "Webhook API Key (Optional)", "type": "string", "description": "API key for webhook authentication (sent in Authorization header). Works with: [Google, Apple, Microsoft, Tencent]" } } }, "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 } } } } } } } } } }