{ "openapi": "3.0.1", "info": { "title": "Google Play Scraper: Reviews & App Health Report", "description": "Google Play reviews and app details, plus an App health report: which release hurt the rating, top complaints, developer reply rate. No login. $0.30 per 1,000 reviews, less on paid plans. For ASO, product teams and competitor research.", "version": "0.1", "x-build-id": "LMxCRDCr0Qgo6k6Zh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brainfoods_studio~google-play-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brainfoods_studio-google-play-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/brainfoods_studio~google-play-scraper/runs": { "post": { "operationId": "runs-sync-brainfoods_studio-google-play-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/brainfoods_studio~google-play-scraper/run-sync": { "post": { "operationId": "run-sync-brainfoods_studio-google-play-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": 50, "type": "array", "description": "Apps to scrape, up to 50. Give package names like com.spotify.music or Google Play URLs. Duplicates are removed.", "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "Two-letter country code of the Play Store, for example US, GB or IN. Prices, availability and reviews differ by country.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Two-letter language code for app texts and review translations, for example en, de or fr.", "default": "en" }, "includeDetails": { "title": "Include app details", "type": "boolean", "description": "Add one app row per app: title, developer, rating, rating histogram, installs, category, price, content rating and more. Charged per app.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add review rows with text, rating, date, app version, developer reply and Google's aspect ratings. Charged per review.", "default": true }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Stop collecting reviews for an app once this many are delivered. Reviews removed by the star filter do not count. With the health report on, at least 500 are collected.", "default": 200 }, "sort": { "title": "Review order", "enum": [ "newest", "relevant", "rating" ], "type": "string", "description": "Which reviews Google returns first. Newest first is best for monitoring and for the health report.", "default": "newest" }, "stars": { "title": "Only these star ratings", "type": "array", "description": "Keep only reviews with these ratings, as a list of numbers from 1 to 5, for example [1, 2]. Leave empty for all. Reviews that are filtered out are not delivered and not charged.", "items": { "type": "integer", "minimum": 1, "maximum": 5 } }, "healthReport": { "title": "App health report (premium)", "type": "boolean", "description": "Adds a report per app: rating trend, the release that hurt ratings most, complaint themes and which are rising, how fast and how often the developer replies, Google's aspect ratings, and a one-line headline. Also adds free version and theme rows and tags every review with its themes. Turns reviews on and collects at least 500 reviews per app. Charged once per app that has at least 20 reviews.", "default": false }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 8, "type": "integer", "description": "Apps processed in parallel, 1 to 8. The default of 2 is the safest; higher is faster but more likely to be rate-limited by Google.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is strongly recommended. Datacenter is tried first; residential is used automatically after repeated 429s if your plan has it.", "default": { "useApifyProxy": true } }, "monitorKey": { "title": "Monitor: remember results as", "type": "string", "description": "Turns on monitor mode. Reviews are remembered under this name, and later runs with the same name return only reviews you haven't seen. The health report then covers only those new reviews. Use one name per schedule." }, "deliveryWebhookUrl": { "title": "Monitor: send new reviews to", "type": "string", "description": "Optional. A Slack incoming-webhook URL or any HTTPS endpoint. When a monitored run finds new reviews, it posts a short alert with a link to the results, 1 and 2 star reviews first. Charged as one alert per run that sends one. Stored encrypted and hidden from logs, because a webhook URL works like a password." } } }, "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 } } } } } } } } } }