{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Scraper & Change Monitor", "description": "Export Apple App Store reviews with ratings, review text, app versions and country coverage. Track new and updated feedback with stable keys for repeatable exports.", "version": "0.6", "x-build-id": "Y6AehBYQmleP6JcdB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~app-store-reviews-change-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-app-store-reviews-change-monitor", "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/luminar~app-store-reviews-change-monitor/runs": { "post": { "operationId": "runs-sync-luminar-app-store-reviews-change-monitor", "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/luminar~app-store-reviews-change-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-app-store-reviews-change-monitor", "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": { "workflow": { "title": "What do you want to do?", "enum": [ "export", "monitor" ], "type": "string", "description": "Export reviews once, or keep a named watch that adds change records on repeat runs.", "default": "export" }, "apps": { "title": "Apps: IDs, App Store URLs or bundle IDs", "minItems": 1, "maxItems": 50, "type": "array", "description": "One app per line. Example: 324684580, https://apps.apple.com/us/app/spotify/id324684580, or com.spotify.client. Up to 50 apps.", "items": { "type": "string" }, "default": [ "324684580" ] }, "countries": { "title": "Country storefronts", "minItems": 1, "maxItems": 20, "type": "array", "description": "Two-letter country codes, for example us, gb, de. This list applies to every app, including pasted URLs. Up to 20 countries.", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" }, "default": [ "us" ] }, "sort": { "title": "Review order", "enum": [ "mostRecent", "mostHelpful" ], "type": "string", "description": "Choose the review order within each app and country. Monitoring works within the selected review window.", "default": "mostRecent" }, "maxReviewsPerApp": { "title": "Maximum reviews per app and country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Up to 500 available reviews for each app and country. This is a source window, not a full historical archive.", "default": 100 }, "maxReviews": { "title": "Maximum reviews in this run", "minimum": 1, "maximum": 25000, "type": "integer", "description": "Total review limit across all apps and countries. Start with 100; raise it for larger exports.", "default": 100 }, "since": { "title": "Only reviews from this date", "type": "string", "description": "Optional ISO date, for example 2026-09-01. Older reviews are excluded before delivery. Leave blank for the available window.", "default": "" }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Lowest rating to include, from 1 to 5. Filtered-out reviews are not billed.", "default": 1 }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Highest rating to include. Set 1 or 2 to focus on critical feedback.", "default": 5 }, "includeAppMetadata": { "title": "Include app name and developer", "type": "boolean", "description": "Adds published app name, developer and bundle ID when available. Missing metadata stays empty; review identity remains available.", "default": true }, "firstRunBehavior": { "title": "First monitoring run", "enum": [ "emit_current_as_new", "seed_only" ], "type": "string", "description": "Both options export and bill current checked reviews. This setting only changes whether the first run also returns NEW change records.", "default": "emit_current_as_new" }, "stateNamespace": { "title": "Watch name", "pattern": "^[A-Za-z0-9_-]{1,50}$", "type": "string", "description": "Keep this name and the same apps, countries, sort, filters and limits on repeat runs. Use a new name to start a separate watch. Up to 25,000 remembered reviews.", "default": "default" }, "maxBuyerChargeUsd": { "title": "Maximum buyer charge (USD)", "minimum": 0, "maximum": 100, "type": "number", "description": "The run checks that your budget can cover the requested app-country checks and review limit before collection. Also set Apify maximum total charge.", "default": 1 }, "maxRuntimeSecs": { "title": "Maximum collection time (seconds)", "minimum": 10, "maximum": 60, "type": "integer", "description": "Limits review collection to 10–60 seconds, with additional time reserved for saving results. Large runs may report partial or capped coverage.", "default": 60 } } }, "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 } } } } } } } } } }