{ "openapi": "3.0.1", "info": { "title": "App & Extension Review Intelligence", "description": "Monitor public reviews from Google Play, Apple App Store, and Chrome Web Store. Extract normalized review records, detect new reviews, classify sentiment/topics, create app summaries, and send webhook alerts.", "version": "0.1", "x-build-id": "p1ZKZFBAbs14SjRDm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraping_scrap~app-extension-review-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraping_scrap-app-extension-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/scraping_scrap~app-extension-review-intelligence/runs": { "post": { "operationId": "runs-sync-scraping_scrap-app-extension-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/scraping_scrap~app-extension-review-intelligence/run-sync": { "post": { "operationId": "run-sync-scraping_scrap-app-extension-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" ], "properties": { "apps": { "title": "Apps and extensions", "minItems": 1, "type": "array", "description": "Apps or browser extensions to scrape from public review surfaces. Each item needs a store and store-specific ID.", "items": { "type": "object", "required": [ "store", "id" ], "properties": { "store": { "title": "Store", "type": "string", "description": "Review source for this target.", "enum": [ "google_play", "app_store", "chrome_web_store" ] }, "id": { "title": "App or extension ID", "type": "string", "description": "Google Play package name, Apple numeric app ID, or Chrome extension ID.", "minLength": 1, "maxLength": 256 }, "country": { "title": "Country", "type": "string", "description": "Optional per-target country or storefront override, for example US or GB." }, "language": { "title": "Language", "type": "string", "description": "Optional per-target language override, for example en or pt-BR. If omitted, global languages are used." } } } }, "maxReviewsPerApp": { "title": "Maximum reviews per app", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum public reviews to collect per concrete app-country-language target. Defaults to 100 when omitted." }, "maxReviewsPerTarget": { "title": "Maximum reviews per target", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Alias for maxReviewsPerApp. Use this when thinking in concrete targets: store + appId + country + language." }, "ratings": { "title": "Ratings", "type": "array", "description": "Ratings to keep after normalization. Use this to focus output on low-rated or high-rated reviews.", "items": { "type": "integer" }, "default": [ 1, 2, 3, 4, 5 ] }, "languages": { "title": "Languages", "minItems": 1, "maxItems": 50, "type": "array", "description": "Default language codes used when a target does not specify a language.", "items": { "type": "string" }, "default": [ "en" ] }, "countries": { "title": "Countries", "minItems": 1, "maxItems": 50, "type": "array", "description": "Default country or storefront codes used when a target does not specify a country.", "items": { "type": "string" }, "default": [ "US" ] }, "onlyNewSinceLastRun": { "title": "Only new since last run", "type": "boolean", "description": "Push only review records whose fingerprints are not already present in the persisted state for this stateKey.", "default": false }, "stateKey": { "title": "State key", "pattern": ".*[A-Za-z0-9_-].*", "minLength": 1, "maxLength": 128, "type": "string", "description": "Namespace for incremental state in the Actor's internal named Key-Value Store. Use different keys for independent monitoring streams.", "default": "default" }, "includeTopicClassification": { "title": "Include topic classification", "type": "boolean", "description": "Classify negative reviews into local rule-based topics such as bug_crash, billing, login, and performance.", "default": true }, "includeAppSummary": { "title": "Include app summary", "type": "boolean", "description": "Push app_summary records with rating, sentiment, topic, new-review, and developer-reply metrics.", "default": true }, "webhookUrl": { "title": "Webhook URL", "pattern": "^(|https?://[^\\s]+)$", "type": "string", "description": "Optional HTTP(S) endpoint that receives one final JSON payload with summaries and new negative reviews.", "default": "" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Standard Apify proxy configuration used for store HTTP requests when a proxy URL is available.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 25, "type": "integer", "description": "Maximum number of store targets fetched in parallel.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout seconds", "minimum": 1, "maximum": 300, "type": "integer", "description": "Timeout for public HTTP store requests.", "default": 30 }, "maxRequestRetries": { "title": "Maximum request retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum retry attempts for transient store request failures.", "default": 3 }, "maxTargets": { "title": "Maximum expanded targets", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Safety limit for expanded concrete targets after applying countries and languages.", "default": 100 }, "maxTotalReviews": { "title": "Maximum total review budget", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Safety limit for expandedTargets.length multiplied by the resolved per-target review limit.", "default": 10000 } } }, "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 } } } } } } } } } }