{ "openapi": "3.0.1", "info": { "title": "App Store Reviews Monitor: iOS App Reviews", "description": "Returns iOS App Store reviews for any app in up to 40 countries: stars, title, text, app version, author and date, plus the app's average rating. Filter by stars, keywords and date. Monitor mode returns only reviews you have not seen.", "version": "0.0", "x-build-id": "rpYHXwsfDOfIMmOhi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brightknot~app-store-reviews-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brightknot-app-store-reviews-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/brightknot~app-store-reviews-monitor/runs": { "post": { "operationId": "runs-sync-brightknot-app-store-reviews-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/brightknot~app-store-reviews-monitor/run-sync": { "post": { "operationId": "run-sync-brightknot-app-store-reviews-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", "required": [ "apps" ], "properties": { "apps": { "title": "Apps", "type": "array", "description": "Apps to read, one per item: an App Store URL (https://apps.apple.com/us/app/instagram/id389801252), a numeric app id (389801252) or an app name (the first App Store search result is used).", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "App Store storefronts to read, as 2-letter country codes (us, gb, de, ae, jp). Each country has its own reviews. Write 'all' for 40 large storefronts. Leave empty to use the country in each app URL, or us.", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app per country", "minimum": 1, "maximum": 500, "type": "integer", "description": "Return at most this many reviews for each app in each country, newest first. Apple publishes the 500 most recent reviews per country, so 500 is the maximum.", "default": 500 }, "ratings": { "title": "Star ratings", "type": "array", "description": "Only return reviews with these star ratings, e.g. 1 and 2 for complaints. Leave empty for all ratings.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Only return reviews whose title or text contains at least one of these words or phrases (not case sensitive), e.g. crash, login, refund. Leave empty for all reviews.", "items": { "type": "string" } }, "sinceDays": { "title": "Only reviews from the last N days", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only return reviews posted in the last N days. Leave empty or 0 for no date limit." }, "monitorMode": { "title": "Monitor mode: only new reviews", "type": "boolean", "description": "Remember which reviews were returned and, on later runs, return only reviews not returned before. The first run returns the current reviews. Schedule it daily and you only pay for new reviews. For a one-off pull set it to false, otherwise a repeat call can return 0 rows.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Keeps a separate memory of seen reviews for each name. Use a different name for each schedule or client so they do not share state.", "default": "default" }, "includeAppInfo": { "title": "Add app details to each row", "type": "boolean", "description": "Add the app name, developer, average rating, rating count and App Store link to every review row. Turn off for smaller rows.", "default": true }, "maxConcurrency": { "title": "Parallel requests", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many requests to Apple run at the same time. Keep it low to avoid rate limits.", "default": 4 } } }, "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 } } } } } } } } } }