{ "openapi": "3.0.1", "info": { "title": "Apple App Store Reviews API - Review Intelligence", "description": "[💵 $2.50 / 1K] Export Apple App Store reviews with app metadata, rating distribution, complaint themes, version signals, and summary rows. Not just raw review text.", "version": "0.1", "x-build-id": "0PRiQLhWoZDOcidYC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdata_labs~apple-app-store-reviews-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdata_labs-apple-app-store-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/webdata_labs~apple-app-store-reviews-api/runs": { "post": { "operationId": "runs-sync-webdata_labs-apple-app-store-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/webdata_labs~apple-app-store-reviews-api/run-sync": { "post": { "operationId": "run-sync-webdata_labs-apple-app-store-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", "properties": { "appIds": { "title": "Apple app IDs", "type": "array", "description": "Apple numeric app IDs. Example: Slack is 618783545. If app URLs are provided too, both lists are merged and deduplicated.", "items": { "type": "string" } }, "appUrls": { "title": "App Store URLs", "type": "array", "description": "Apple App Store app URLs. The Actor extracts the numeric id from URLs like https://apps.apple.com/us/app/slack/id618783545.", "items": { "type": "string" } }, "appNames": { "title": "App names to search", "type": "array", "description": "Optional app names to resolve through Apple's public Search API. Direct app IDs are more reliable.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter App Store country codes. Reviews are country-specific, so use the markets you care about.", "default": [ "us" ], "items": { "type": "string" } }, "sortBy": { "title": "Review sort", "enum": [ "mostrecent", "mosthelpful" ], "type": "string", "description": "Apple RSS review sort. Most recent is best for monitoring; most helpful is useful for complaint mining.", "default": "mostrecent" }, "ratings": { "title": "Ratings filter", "type": "array", "description": "Optional star ratings to keep. Leave empty for all ratings. Use 1 and 2 for complaint mining.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [] }, "includePositiveReviews": { "title": "Include positive reviews", "type": "boolean", "description": "When false, keep only 1-3 star reviews in the review rows but still compute summary metrics from fetched reviews.", "default": true }, "maxReviewsPerApp": { "title": "Max reviews per app/country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum review rows to return for each app and country. Low default keeps trial runs fast and cheap.", "default": 100 }, "maxSearchResults": { "title": "Max app search results", "minimum": 1, "maximum": 10, "type": "integer", "description": "When using appNames, resolve up to this many apps per name and country.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Apple's public RSS/Search endpoints usually work without a proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }