{ "openapi": "3.0.1", "info": { "title": "App Reviews API (App Store & Google Play)", "description": "Scrape and unify reviews and ratings from Apple App Store and Google Play into one standardized dataset schema. HTTP-only, fast, zero browser overhead.", "version": "1.0", "x-build-id": "G2LWI0w191dOyaA7y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/headlessagent~app-reviews-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-headlessagent-app-reviews-api", "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/headlessagent~app-reviews-api/runs": { "post": { "operationId": "runs-sync-headlessagent-app-reviews-api", "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/headlessagent~app-reviews-api/run-sync": { "post": { "operationId": "run-sync-headlessagent-app-reviews-api", "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" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "List of apps to scrape reviews for. Each object must contain 'store' ('apple' or 'google') and 'id' (bundle id, numeric App Store id, or store URL). Optionally provide 'country' to override default countries for this app.", "items": { "type": "object", "required": [ "store", "id" ], "properties": { "store": { "title": "Store", "type": "string", "enum": [ "apple", "google" ], "description": "Store platform: 'apple' for iOS App Store or 'google' for Google Play Store." }, "id": { "title": "App ID or URL", "type": "string", "description": "App identifier: bundle id (e.g. 'com.whatsapp'), numeric id for Apple (e.g. '544007664'), or direct store URL." }, "country": { "title": "Country", "type": "string", "description": "Optional ISO 3166-1 alpha-2 country code override (e.g. 'us', 'gb', 'de')." } } } }, "countries": { "title": "Default Countries", "type": "array", "description": "Array of ISO 3166-1 alpha-2 country codes to fetch reviews from when not explicitly specified per app.", "items": { "type": "string" }, "default": [ "us" ] }, "sort": { "title": "Sort order", "enum": [ "recent", "helpful" ], "type": "string", "description": "Sort order for reviews: 'recent' (default) or 'helpful' when supported by the store.", "default": "recent" }, "since": { "title": "Since (Date)", "type": "string", "description": "Optional ISO 8601 date cutoff (e.g. '2026-01-01'). Reviews older than this date are omitted and pagination stops." }, "maxReviews": { "title": "Max reviews per app", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of reviews to collect per app across all target countries (hard cap).", "default": 200 }, "includeAppInfo": { "title": "Include app info", "type": "boolean", "description": "Include app metadata (title, average rating, rating count) denormalized onto each review item.", "default": true } } }, "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 } } } } } } } } } }