{ "openapi": "3.0.1", "info": { "title": "📱 App Rating Monitor - Track Rating Drops & Bad Reviews", "description": "⚡ Know within hours when your app's rating slips or angry reviews spike. ✅ App Store and Steam ratings, rating counts and review sentiment tracked over time. ✅ Alerts on a rating drop or a negative-review spike, with built-in rating history.", "version": "1.0", "x-build-id": "e1mF16AuWNDY0pbeb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/that_red_bird~app-rating-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-that_red_bird-app-rating-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/that_red_bird~app-rating-monitor/runs": { "post": { "operationId": "runs-sync-that_red_bird-app-rating-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/that_red_bird~app-rating-monitor/run-sync": { "post": { "operationId": "run-sync-that_red_bird-app-rating-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 to watch", "type": "array", "description": "App Store URLs or ids (id310633997) and Steam URLs or appids (440). To be explicit: {\"app\":\"440\",\"store\":\"steam\"}.", "default": [ "https://apps.apple.com/us/app/whatsapp-messenger/id310633997", "https://store.steampowered.com/app/440/" ] }, "reviewSample": { "title": "Reviews sampled per run", "minimum": 10, "maximum": 500, "type": "integer", "description": "How many recent reviews to read for the sentiment figures. Bigger samples are steadier but slower.", "default": 100 }, "ratingDropAlert": { "title": "Alert when rating falls by (hundredths of a star)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Raise an alert when the store rating drops by at least this much since the previous run, expressed in hundredths of a star: 20 = 0.20 stars, 50 = half a star. Apify input schemas only accept whole numbers, hence the unit.", "default": 20 }, "negativeSpikePercent": { "title": "Alert when negative reviews reach %", "minimum": 1, "maximum": 100, "type": "integer", "description": "Raise an alert when this percentage or more of the sampled reviews are 1-2 stars.", "default": 40 }, "country": { "title": "App Store country", "type": "string", "description": "Two-letter country code for Apple, e.g. us, gb, de.", "default": "us" }, "language": { "title": "Steam review language", "type": "string", "description": "Steam review language filter, e.g. english, all.", "default": "english" }, "keepHistory": { "title": "Rating history length", "minimum": 0, "maximum": 500, "type": "integer", "description": "How many past readings to keep per app so you can chart the rating over time.", "default": 60 }, "onlyChanges": { "title": "Only output alerts and changes", "type": "boolean", "description": "Push only apps whose numbers moved or that raised an alert.", "default": false }, "alertOnErrorAfter": { "title": "Report a broken app after N failures", "minimum": 0, "maximum": 50, "type": "integer", "description": "Flags an app that keeps failing — often delisted or region-locked. 0 disables it.", "default": 3 }, "resetBaseline": { "title": "Reset baseline", "type": "boolean", "description": "Forget stored ratings and start fresh.", "default": false }, "maxItems": { "title": "Max output rows", "minimum": 0, "type": "integer", "description": "Hard cap on dataset rows per run. 0 = no cap.", "default": 0 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many apps to check in parallel.", "default": 3 }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POSTed when a rating drops or negative reviews spike. Slack/Discord/Zapier compatible." }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Named key-value store holding previous ratings and history.", "default": "app-rating-monitor-state" } } }, "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 } } } } } } } } } }